From 2a392e890f6eb1f0f4e3a71742720af8f056333a Mon Sep 17 00:00:00 2001 From: dlee-bq Date: Mon, 2 Nov 2026 04:56:46 +0000 Subject: [PATCH] [BugFix] `openbb-cli`: Add api-prefix and overlay support to spec generation (#7811) * feat(cli): add api-prefix and overlay support to spec generation Add --api-prefix and --overlay options to the spec-generation command so commands can be named from a URL path prefix and OpenAPI Overlay 1.0 documents can be applied before building the spec. Normalize router segments so a leading digit gets an underscore and a Python keyword gets a trailing one, and add mounted_command_paths to map spec paths to the paths they mount at under obb. * fix: remove local-only entries from .gitignore Remove .claude/ and github_metadata/ patterns that only exist locally and have no business in the shared repository. --------- Co-authored-by: dlee-bq <325002271+dlee-bq@users.noreply.github.com> --- cli/CODEGEN_EODHD_DEMO.md | 401 + cli/README.md | 16 + cli/openbb_cli/cli.py | 41 +- cli/openbb_cli/codegen/fetcher_gen.py | 559 +- cli/openbb_cli/codegen/package_gen.py | 10 +- cli/openbb_cli/codegen/post_gen.py | 76 +- cli/openbb_cli/codegen/project_gen.py | 2 +- cli/openbb_cli/codegen/pydantic_gen.py | 202 +- cli/openbb_cli/codegen/router_gen.py | 30 + cli/openbb_cli/codegen/test_gen.py | 225 +- cli/openbb_cli/dispatchers/_unpack.py | 140 +- cli/openbb_cli/dispatchers/http.py | 140 +- cli/openbb_cli/dispatchers/openapi_schema.py | 63 +- cli/openbb_cli/dispatchers/overlay.py | 268 + cli/openbb_cli/dispatchers/runtime.py | 25 + cli/openbb_cli/dispatchers/spec.py | 445 +- cli/tests/test_cli.py | 196 + cli/tests/test_codegen_fetcher_gen.py | 749 + cli/tests/test_codegen_package_gen.py | 68 + cli/tests/test_codegen_post_gen.py | 94 + cli/tests/test_codegen_project_gen.py | 12 + cli/tests/test_codegen_pydantic_gen.py | 205 + cli/tests/test_codegen_router_gen.py | 17 + cli/tests/test_codegen_test_gen.py | 263 +- cli/tests/test_dispatchers_http.py | 287 + cli/tests/test_dispatchers_openapi_schema.py | 6 + cli/tests/test_dispatchers_overlay.py | 277 + cli/tests/test_dispatchers_spec.py | 792 + cli/tests/test_dispatchers_unpack.py | 183 +- .../core/openbb/assets/reference.json | 298494 ++++++++++++++- 30 files changed, 304136 insertions(+), 150 deletions(-) create mode 100644 cli/CODEGEN_EODHD_DEMO.md create mode 100644 cli/openbb_cli/dispatchers/overlay.py create mode 100644 cli/tests/test_dispatchers_overlay.py diff --git a/cli/CODEGEN_EODHD_DEMO.md b/cli/CODEGEN_EODHD_DEMO.md new file mode 100644 index 00000000000..6634434ae2d --- /dev/null +++ b/cli/CODEGEN_EODHD_DEMO.md @@ -0,0 +1,401 @@ +# `openbb-cli` codegen + EODHD data exploration + +## Part 1 — Codegen: OpenAPI spec → installable OpenBB extension + +`openbb --generate-spec` snapshots any OpenAPI 3.x document into a `.spec` file; `--generate-extension` +turns that `.spec` into a full `Provider` + `Fetcher` + `Router` package that registers with +`openbb-build` like any first-party extension. Worked example against the NY Fed Markets API, +which publishes its OpenAPI document at a non-default path: + +```bash +openbb --generate-spec \ + --server https://markets.newyorkfed.org \ + --openapi-path /static/docs/markets-api.yml \ + --output nyfed.spec +# wrote 53 commands to nyfed.spec +``` + +### What's inside a `.spec` file + +It's a self-contained JSON snapshot: `base_url`, every command's parameters, and full +`response_schema` per content type (including the upstream's XML shape, when it has one). Real +excerpt for `ambs.latest`: + +```json +{ + "base_url": "https://markets.newyorkfed.org", + "api_prefix": "/api", + "commands": { + "ambs.latest": { + "url_path": "/api/ambs/{operation}/{status}/{include}/latest.{format}", + "method": "get", + "description": "Returns the latest AMBS operation Announcements or Results for the current day.", + "parameters": [ + { + "name": "operation", + "in": "path", + "type": "string", + "required": true, + "choices": ["all", "purchases", "sales", "roll", "swap"], + "help": "The operation type" + }, + { + "name": "status", + "in": "path", + "type": "string", + "required": true, + "choices": ["announcements", "results"], + "help": "The operation status" + } + ] + } + } +} +``` + +Because it's precomputed, dispatching against `--spec nyfed.spec` skips the OpenAPI fetch + parse +on every call (~50ms cold start vs. a live `--server` fetch). + +### Generate the extension project + +```bash +openbb --generate-extension \ + --spec nyfed.spec \ + --provider-name nyfed \ + --output ./openbb-nyfed +# wrote project to openbb-nyfed/openbb-nyfed +# providers (1): nyfed +# routers (1): nyfed +# fetchers: 53 GET (across all providers) +# POST: 0 local-compute commands +# install: pip install -e openbb-nyfed/openbb-nyfed +# build: openbb-build +``` + +``` +openbb-nyfed/openbb-nyfed/ +├── pyproject.toml # entry points: openbb_provider_extension, openbb_core_extension +├── README.md +└── openbb_nyfed/ + ├── providers/nyfed/ + │ ├── __init__.py # nyfed_provider = Provider(name="nyfed", fetcher_dict={...}) + │ └── models/ambs_latest.py # QueryParams + Data + Fetcher, one file per command + └── routers/ + ├── nyfed.py # root router, include_router() per sub-namespace + ├── ambs.py + ├── rates.py + ├── soma.py + └── ... # one file per top-level path segment +``` + +```bash +pip install -e ./openbb-nyfed/openbb-nyfed +openbb-build +python -c "from openbb import obb; print(obb.nyfed.rates.all.latest().to_df())" +``` + +### Codegen against EODHD — a second real API, warts included + +EODHD publishes its own OpenAPI 3.1 document (not at the default `/openapi.json`), which is a good +stress test for `--openapi-path` accepting a fully-qualified URL independent of `--server`: + +```bash +openbb --generate-spec \ + --server https://eodhd.com/api \ + --openapi-path https://eodhistoricaldata.github.io/EODHD-openapi/openapi.yaml \ + --output eodhd.spec +# wrote 87 commands to eodhd.spec +``` + +```bash +openbb --generate-extension --spec eodhd.spec --provider-name eodhd --output ./openbb-eodhd +``` + +``` +E741 Ambiguous variable name: `l` + --> openbb-eodhd/openbb-eodhd/openbb_eodhd/providers/eodhd/models/history.py:77:5 + | +77 | l: float | None = Field(default=None, description='Low price.') + +wrote project to openbb-eodhd/openbb-eodhd + providers (1): eodhd + routers (1): eodhd + fetchers: 87 GET (across all providers) + POST: 0 local-compute commands + install: pip install -e openbb-eodhd/openbb-eodhd + build: openbb-build +``` + +That ruff warning is genuine: the generator maps a `low` field literally named `l` in the OHLC +schema and doesn't rename single-letter identifiers. Codegen output is a starting point, not +guaranteed lint-clean — worth a pass before shipping the package. + +Two things worth inspecting in the generated code: + +**Credential auto-detection** — EODHD's `api_token` query param was recognized as a credential and +promoted onto the provider, so once installed, `openbb` reads it from user settings instead of +requiring a flag on every call: + +```python +# openbb_eodhd/providers/eodhd/__init__.py +eodhd_provider = Provider( + name="eodhd", + description="eodhd provider proxied through https://eodhd.com/api.", + credentials=["api_token"], + website="https://eodhd.com/api", + fetcher_dict={ + "History": HistoryFetcher, + "BulkFundamentals": BulkFundamentalsFetcher, + "Eod": EodFetcher, + # ... 84 more + }, +) +``` + +**Typed router command** — every command becomes a real `@router.command`, so `obb.eodhd.eod(...)` +gets full auto-completion and an `OBBject` envelope, same as any first-party command: + +```python +# openbb_eodhd/routers/eodhd.py +@router.command(model="Eod") +async def eod( + cc: CommandContext, + provider_choices: ProviderChoices, + standard_params: StandardParams, + extra_params: ExtraParams, +) -> OBBject: + """Retrieve end-of-day historical data for a specific company by its ticker symbol, with optional filters for specific data points.""" + return await OBBject.from_query(Query(**locals())) +``` + +**Credential naming gotcha** — if you already have OpenBB's legacy EODHD credential saved +(`eodhd_api_key`, from the old first-party provider), it will **not** be picked up here. The +generated Fetcher reads `credentials.get("eodhd_api_token", "")` — matching the provider name +(`eodhd`) plus the exact query param the live spec declares (`api_token`, not `api_key`). +Add the matching key to `~/.openbb_platform/user_settings.json`: + +```json +{ + "credentials": { + "eodhd_api_key": "", + "eodhd_api_token": "" + } +} +``` + +With that in place, install + build and it passes through with no key on the call site: + +```bash +pip install -e ./openbb-eodhd/openbb-eodhd +openbb-build +``` + +``` +Extensions to add: eodhd@0.1.0 +Building... +``` + +```python +from openbb import obb + +obb.eodhd.eod(ticker="MSFT.US", from_="2024-01-01", to="2024-01-10").to_df() +``` + +``` + open high low close adjusted_close volume +date +2024-01-02 373.86 375.90 366.77 370.87 363.1179 25258600 +2024-01-03 369.01 373.26 368.51 370.60 362.8536 23083500 +2024-01-04 370.67 373.10 367.17 367.94 360.2492 20901500 +2024-01-05 368.97 372.06 366.50 367.75 360.0632 21004600 +2024-01-08 369.30 375.20 369.01 374.69 366.8581 23134000 +2024-01-09 372.01 375.99 371.19 375.79 367.9351 20830000 +2024-01-10 376.37 384.17 376.32 382.77 374.7692 25514200 +``` + +This is `MSFT.US` — not `AAPL.US`/`VTI.US` from the demo key's allowlist — confirming the real key is +what's actually being used, resolved automatically from user settings. `search`, which returned +`HTTP403` under the restricted demo key in Part 2 below, also succeeds now: + +```python +obb.eodhd.search(query="Microsoft").to_df().head(3) +``` + +``` + Code Exchange ... previousCloseDate isPrimary +0 MSFT US ... 2026-09-24 True +1 MSFT BA ... 2026-09-24 False +2 MSFTX-USD CC ... 2026-09-25 False +``` + +## Part 2 — Data exploration against EODHD (spec-driven, no install required) + +Everything in this section runs straight off `eodhd.spec` — no extension install, no `openbb-build`. +This is the fast path for exploring an API before deciding it's worth turning into a permanent +extension. + +### Discover the surface + +```bash +openbb --spec eodhd.spec --list-commands +``` + +87 commands span EOD prices, fundamentals, calendar events, options, sanctions lists, credit-risk +indices, and more: + +```json +{"name": "eod", "description": "Retrieve end-of-day historical data for a specific company by its ticker symbol, with optional filters for specific data points"} +{"name": "real-time", "description": "Retrieve live (delayed) stock prices for specified ticker(s)"} +{"name": "calendar.earnings", "description": "Fetches upcoming earnings data, with optional parameters for date ranges and specific symbols"} +{"name": "fundamentals", "description": "Fetches various sections of fundamental data for a given stock symbol"} +{"name": "screener", "description": "Retrieves stock data filtered by criteria such as market capitalization, exchange, sector, and more"} +{"name": "sanctions.entities", "description": "Returns sanctioned entities (individuals and organizations) aggregated from OFAC and other sanctions sources"} +``` + +```bash +openbb --spec eodhd.spec --describe eod +``` + +```json +{ + "parameters": [ + {"name": "ticker", "in": "path", "type": "string", "required": true, "help": "Ticker symbol of the company"}, + {"name": "fmt", "in": "query", "type": "string", "default": "json", "choices": ["json", "csv"]}, + {"name": "from", "in": "query", "type": "string", "help": "Start date (YYYY-MM-DD)"}, + {"name": "to", "in": "query", "type": "string", "help": "End date (YYYY-MM-DD)"}, + {"name": "period", "in": "query", "type": "string", "choices": ["d", "w", "m"]}, + {"name": "api_token", "in": "query", "type": "string", "help": "EODHD API key"} + ] +} +``` + +### Auth + +EODHD takes the key as a query param, not a header — use `-Q`: + +```bash +openbb --spec eodhd.spec eod --ticker AAPL.US +# {"ok": false, "error": {"type": "HTTP401", "message": "Unauthenticated"}} + +openbb --spec eodhd.spec -Q api_token=demo eod --ticker AAPL.US --from 2024-01-01 --to 2024-01-10 +``` + +`demo` is EODHD's public demo key — real, rate-limited, and scoped to `AAPL.US`/`VTI.US`/a handful +of other symbols, which is why every example below uses it. Swap in +`OPENBB_HTTP_QUERY_API_TOKEN=` (or `-Q api_token=...`) for unrestricted symbols. + +**Gotcha found while testing:** the spec declares `fmt` defaults to `json`, but EODHD's live API +actually defaults to CSV when `fmt` is omitted — pass `--fmt json` explicitly if you want structured +output. Published API docs and live behavior drift; this is exactly the kind of thing worth +smoke-testing before building automation on a generated spec. + +### Pull real data + +```bash +openbb --spec eodhd.spec -Q api_token=demo eod \ + --ticker AAPL.US --fmt json --from 2024-01-01 --to 2024-01-10 +``` + +```json +{"ok": true, "result": [ + {"date": "2024-01-02", "open": 187.15, "high": 188.44, "low": 183.89, "close": 185.64, "adjusted_close": 183.404, "volume": 82488700}, + {"date": "2024-01-03", "open": 184.22, "high": 185.88, "low": 183.43, "close": 184.25, "adjusted_close": 182.0308, "volume": 58414500}, + {"date": "2024-01-10", "open": 184.35, "high": 186.4, "low": 183.92, "close": 186.19, "adjusted_close": 183.9474, "volume": 46792900} +]} +``` + +```bash +openbb --spec eodhd.spec -Q api_token=demo real-time --ticker AAPL.US +# {"ok": true, "result": {"code": "AAPL.US", "close": 335.92, "previousClose": 337.02, "change": -1.1, "change_p": -0.3264, ...}} + +openbb --spec eodhd.spec -Q api_token=demo fundamentals --ticker AAPL.US +# {"ok": true, "result": {"General": {"Code": "AAPL", "Name": "Apple Inc.", "Sector": "Technology", "Industry": "Consumer Electronics", ...}}} +``` + +### Batch mode — several EODHD calls in one shot + +```bash +cat <<'EOF' | openbb --spec eodhd.spec -Q api_token=demo --batch +{"id":"eod","command":"eod","params":{"ticker":"AAPL.US","fmt":"json","from":"2024-06-01","to":"2024-06-05"}} +{"id":"rt","command":"real-time","params":{"ticker":"AAPL.US"}} +EOF +``` + +```json +{"id": "eod", "ok": true, "result": [ + {"date": "2024-06-03", "open": 192.9, "high": 194.99, "low": 192.52, "close": 194.03, "volume": 50080500}, + {"date": "2024-06-04", "open": 194.64, "high": 195.32, "low": 193.03, "close": 194.35, "volume": 47471400}, + {"date": "2024-06-05", "open": 195.4, "high": 196.9, "low": 194.87, "close": 195.87, "volume": 54156800} +]} +{"id": "rt", "ok": true, "result": {"code": "AAPL.US", "close": 335.92, "change_p": -0.3264}} +``` + +### From JSON to a DataFrame + +The CLI's job stops at a JSON envelope; pandas takes it from there: + +```python +import json +import subprocess +import pandas as pd + +out = subprocess.run( + [ + "openbb", + "--spec", + "eodhd.spec", + "-Q", + "api_token=demo", + "eod", + "--ticker", + "AAPL.US", + "--fmt", + "json", + "--from", + "2024-01-01", + "--to", + "2024-03-29", + ], + capture_output=True, + text=True, + check=True, +).stdout + +rows = json.loads(out)["result"] +df = pd.DataFrame(rows) +df["date"] = pd.to_datetime(df["date"]) +df = df.set_index("date") + +print(df[["close", "volume"]].describe()) +print(df["close"].rolling(20).mean().tail()) +``` + +``` + close volume +count 61.000000 6.100000e+01 +mean 181.830328 6.200321e+07 +std 7.413215 1.924904e+07 +min 169.000000 4.047780e+07 +25% 173.720000 4.912840e+07 +50% 182.680000 5.652950e+07 +75% 186.860000 6.966880e+07 +max 195.180000 1.366826e+08 + +date +2024-03-22 174.7270 +2024-03-25 174.2115 +2024-03-26 173.5655 +2024-03-27 173.1600 +2024-03-28 172.6965 +Name: close, dtype: float64 +``` + +Once `openbb-eodhd` is installed and built (Part 1), the same exploration reads more naturally off +the typed surface: `obb.eodhd.eod(ticker="AAPL.US", from_="2024-01-01", to="2024-03-29", api_token="demo").to_df()`. + +## Reference + +- `cli/README.md` — full flag reference for `--generate-spec`, `--generate-extension`, multi-spec + mounting, auth hooks, batch mode, and the REPL. +- NY Fed Markets API: +- EODHD OpenAPI document: diff --git a/cli/README.md b/cli/README.md index 83f1d414936..077ad295964 100644 --- a/cli/README.md +++ b/cli/README.md @@ -85,6 +85,22 @@ openbb --generate-spec --server https://api.congress.gov --output congress.spec openbb --spec congress.spec law --congress 119 --limit 5 ``` +Two flags shape the spec as it is generated: + +| Flag | What it does | +|------|--------------| +| `--api-prefix PREFIX` | Strips `PREFIX` from each path when naming commands, e.g. `--api-prefix /api/v3` names `/api/v3/klines` `klines` instead of `api.v3.klines`. Paths outside the prefix keep their full name; request URLs are unchanged. A path the prefix strips to nothing (the prefix itself, or the prefix plus only placeholders) is skipped; with an explicit `--api-prefix` a warning lists those paths. Default: the longest prefix the paths share, leaving out each path's last segment. | +| `--overlay PATH` | Applies an [OpenAPI Overlay 1.0](https://spec.openapis.org/overlay/v1.0.0) document (YAML or JSON) to the fetched OpenAPI description before the spec is built, to correct upstream schema errors without editing generated code. Repeatable; overlays apply in order. Targets use the JSONPath subset `$`, `.name`, `['name']`, `[index]` and `*`; a target that matches nothing is reported as a warning. | + +```bash +openbb --generate-spec \ + --server https://api.binance.com \ + --openapi-path https://raw.githubusercontent.com/binance/binance-api-swagger/master/spot_api.yaml \ + --api-prefix /api/v3 \ + --overlay binance.overlay.yaml \ + --output binance.spec +``` + ### Generate an installable OpenBB extension from a spec A `.spec` file is enough to dispatch commands directly. Going one step further, `--generate-extension` turns that spec into a full installable OpenBB Platform extension package — `Provider(...)` + `Fetcher` classes + a router that mirrors the upstream's namespace tree — that registers with `openbb-build` like any first-party extension. After install, every command shows up on the typed `obb.*` surface (auto-completion, `obb.reference`, `OBBject` envelopes, the works). diff --git a/cli/openbb_cli/cli.py b/cli/openbb_cli/cli.py index 59c664bbc31..efe55eda5d0 100644 --- a/cli/openbb_cli/cli.py +++ b/cli/openbb_cli/cli.py @@ -415,6 +415,8 @@ def _generate_spec( headers: dict[str, str] | None = None, query_params: dict[str, str] | None = None, socrata_story: str | None = None, + api_prefix: str | None = None, + overlays: list[str] | None = None, ) -> int: """Build a precomputed .spec file from one of the supported sources.""" from openbb_cli.dispatchers.spec import write_spec @@ -444,8 +446,27 @@ def _generate_spec( from openbb_cli.dispatchers.spec import build_spec_document openapi = fetch_openapi( - server_url, path=openapi_path, headers=headers, query_params=query_params + server_url, + path=openapi_path, + headers=headers, + query_params=query_params, + normalize=not overlays, ) + if overlays: + from openbb_cli.dispatchers.openapi_schema import expand_type_arrays + from openbb_cli.dispatchers.overlay import apply_overlay, load_overlay + + for overlay_path in overlays: + try: + openapi, unmatched = apply_overlay(openapi, load_overlay(overlay_path)) + except (OSError, ValueError) as exc: + sys.stderr.write(f"--overlay {overlay_path}: {exc}\n") + return 2 + for target in unmatched: + sys.stderr.write( + f"--overlay {overlay_path}: target matched nothing: {target}\n" + ) + openapi = expand_type_arrays(openapi) if openapi_path and ( openapi_path.startswith("http://") or openapi_path.startswith("https://") ): @@ -455,8 +476,22 @@ def _generate_spec( else: source_url = server_url.rstrip("/") + "/openapi.json" spec_doc = build_spec_document( - openapi, base_url=server_url, source_url=source_url, headers=headers + openapi, + base_url=server_url, + api_prefix=api_prefix, + source_url=source_url, + headers=headers, ) + if api_prefix is not None: + from openbb_cli.dispatchers.spec import unnamed_paths + + skipped = unnamed_paths(openapi, api_prefix=api_prefix) + if skipped: + sys.stderr.write( + f"--api-prefix {api_prefix}: no command name is left for " + f"{', '.join(skipped)}; these paths are skipped. Use a shorter " + "prefix to keep them.\n" + ) if not spec_doc["commands"]: sys.stderr.write( f"generated 0 commands from {source_url} — the document exposes no " @@ -815,6 +850,8 @@ def main(argv: list[str] | None = None) -> int: # noqa: PLR0911 headers, query_params, socrata_story=getattr(args, "socrata_story", None), + api_prefix=getattr(args, "api_prefix", None), + overlays=getattr(args, "overlay", None), ) if getattr(args, "generate_extension", False): diff --git a/cli/openbb_cli/codegen/fetcher_gen.py b/cli/openbb_cli/codegen/fetcher_gen.py index 1dadae5be72..8adf9c3a00c 100644 --- a/cli/openbb_cli/codegen/fetcher_gen.py +++ b/cli/openbb_cli/codegen/fetcher_gen.py @@ -2,6 +2,8 @@ from __future__ import annotations +import json +import keyword import re from dataclasses import dataclass, field from typing import Any, cast @@ -16,6 +18,7 @@ from openbb_cli.codegen.pydantic_gen import ( consolidate_imports, generate_class, query_field_name, + query_params_field_names, render_function_docstring, ) @@ -121,7 +124,8 @@ def _module_name_from_command(name: str) -> str: safe = "command" if safe[0].isdigit(): safe = f"_{safe}" - return safe.lower() + safe = safe.lower() + return f"{safe}_" if keyword.iskeyword(safe) else safe _COORDINATE_NAME_RE = re.compile(r"(^|[^a-z])(lat|lon|lng|latitude|longitude)", re.I) @@ -142,14 +146,14 @@ def _mark_null_empty(node: Any) -> Any: return [_mark_null_empty(n) for n in node] if not isinstance(node, dict): return node - out = { - k: ( - v - if k in ("enum", "const", "default", "example", "examples") - else _mark_null_empty(v) - ) - for k, v in node.items() - } + out: dict[str, Any] = {} + for k, v in node.items(): + if k in ("enum", "const", "default", "example", "examples"): + out[k] = v + elif k in ("properties", "patternProperties") and isinstance(v, dict): + out[k] = {name: _mark_null_empty(schema) for name, schema in v.items()} + else: + out[k] = _mark_null_empty(v) if out.get("type") == "object" or "properties" in out: out["x-null-empty"] = True return out @@ -209,7 +213,7 @@ def _query_params_schema( prop_schema = {"type": "string", "x-multiple-items": True} if description: prop_schema["description"] = description - if raw.get("choices"): + if raw.get("choices") and raw.get("list_style") != "json": prop_schema["x-choices"] = list(raw["choices"]) if raw.get("default") is not None: prop_schema["default"] = raw["default"] @@ -231,10 +235,16 @@ def _query_params_schema( properties[body_name] = body_prop if body_name in body_required: required.append(body_name) + required_groups = [ + group + for group in cmd_spec.get("required_groups") or [] + if all(name in properties for alt in group["alternatives"] for name in alt) + ] return { "type": "object", "properties": properties, "required": required, + **({"x-required-groups": required_groups} if required_groups else {}), } @@ -329,6 +339,11 @@ def _unwrap_schema_envelopes(schema: Any) -> dict[str, Any]: return {} typed: dict[str, Any] = schema if typed.get("type") == "array": + kind = _response_shape(typed)[1] + if kind == "tuples": + return _wrap_scalar_as_value(typed["items"]) + if kind == "records": + return _final_row_schema(typed["items"]) return _unwrap_schema_envelopes(typed.get("items")) choice_rows = _wrapper_choice_rows(typed) if choice_rows is not None: @@ -520,11 +535,16 @@ def _response_shape(response: Any) -> tuple[str | None, str | None]: only array, or the only one whose items are objects; every other property is metadata), ``"map"`` when the only property is a free-form ``{key: value}`` map (one row per entry), ``"single"`` when the object is - itself the row, else ``(None, None)``. The data model and the generated - ``unpack_response`` call both use this, so they cannot disagree. + itself the row, ``"tuples"`` when the response is an array of arrays (each + inner array is one positional row), ``"records"`` when it is an array of + objects (each object is one row), else ``(None, None)``. The data model + and the generated ``unpack_response`` call both use this, so they cannot + disagree. """ - if not isinstance(response, dict) or response.get("type") == "array": + if not isinstance(response, dict): return None, None + if response.get("type") == "array": + return None, _array_row_kind(response.get("items")) props = response.get("properties") if not isinstance(props, dict) or not props or "results" in props: return None, None @@ -549,6 +569,17 @@ def _response_shape(response: Any) -> tuple[str | None, str | None]: return None, "single" +def _array_row_kind(items: Any) -> str | None: + """``"tuples"`` for array items that are arrays, ``"records"`` for objects.""" + if not isinstance(items, dict): + return None + if items.get("type") == "array" or "items" in items: + return "tuples" + if items.get("type") == "object" or "properties" in items: + return "records" + return None + + def _envelope_inner_schema( typed: dict[str, Any], props: dict[str, Any], # noqa: ARG001 @@ -599,13 +630,124 @@ def _single_prop_inner_schema(props: dict[str, Any]) -> dict[str, Any] | None: return None +def _merged_data_schema(cmd_spec: dict[str, Any]) -> dict[str, Any]: + """Row schema of a command, covering every URL of a merged command. + + The fields of each URL's row schema are combined. A field declared + differently by several URLs takes every distinct declaration + (``_merge_prop_schemas``) and keeps the first one's docs; declarations + that differ only in docs or nullability count as one (``_shape_key``). A + field stays required only when every URL's row schema requires it. + """ + base = _data_schema(cmd_spec) + variants = cmd_spec.get("template_response_schemas") or {} + if not variants: + return base + schemas = [base] + [ + _data_schema({"response_schema": schema}) for schema in variants.values() + ] + declarations: dict[str, list[Any]] = {} + for schema in schemas: + for name, prop in (schema.get("properties") or {}).items(): + seen = declarations.setdefault(name, []) + if all(_shape_key(prop) != _shape_key(other) for other in seen): + seen.append(prop) + properties: dict[str, Any] = {} + for name, distinct in declarations.items(): + first = distinct[0] + if len(distinct) == 1 or not all(isinstance(d, dict) for d in distinct): + properties[name] = first + continue + merged = first + for other in distinct[1:]: + merged = _merge_prop_schemas(merged, other) + docs = {k: first[k] for k in ("description", "title", "example") if k in first} + properties[name] = {**merged, **docs} + if not properties: + return base + required = set.intersection(*(set(s.get("required") or []) for s in schemas)) + return { + **base, + "type": "object", + "properties": properties, + "required": [name for name in properties if name in required], + } + + +_DOC_KEYS = frozenset({"description", "example", "examples", "title"}) + + +def _shape(schema: Any) -> Any: + """Return ``schema`` without docs or nullability, at every level. + + Descriptions, examples, titles and ``nullable`` are dropped, and an + ``anyOf`` / ``oneOf`` of one schema and ``null`` becomes that schema. + """ + if isinstance(schema, list): + return [_shape(v) for v in schema] + if not isinstance(schema, dict): + return schema + out: dict[str, Any] = {} + for key, value in schema.items(): + if key in ("properties", "patternProperties") and isinstance(value, dict): + out[key] = {name: _shape(sub) for name, sub in value.items()} + elif key not in _DOC_KEYS and key != "nullable": + out[key] = _shape(value) + for combinator in ("anyOf", "oneOf"): + variants = out.get(combinator) + if not isinstance(variants, list): + continue + non_null = [ + v for v in variants if not (isinstance(v, dict) and v.get("type") == "null") + ] + if len(non_null) == 1 and len(non_null) < len(variants): + return non_null[0] + return out + + +def _shape_key(schema: Any) -> str: + """Compare key for a field schema (see ``_shape``).""" + return json.dumps(_shape(schema), sort_keys=True, default=str) + + +def _unpack_kwargs(response_schema: Any) -> dict[str, Any]: + """``unpack_response`` keyword arguments for one response schema.""" + key, kind = _response_shape(response_schema) + if kind is None: + return {} + if kind in ("single", "tuples", "records"): + return {"kind": kind} + return {"rows_key": key, "kind": kind} + + +def _template_unpack_hints( + cmd_spec: dict[str, Any], url_choices: UrlChoices | None +) -> dict[tuple[str, ...], dict[str, Any]] | None: + """Per-URL ``unpack_response`` hints, keyed by each URL's sorted placeholders. + + ``None`` unless the URLs of a merged command declare different response + shapes, in which case the generated code picks the hint for the URL it used. + """ + variants = cmd_spec.get("template_response_schemas") or {} + if not url_choices or not variants: + return None + base = cmd_spec.get("response_schema") + hints: dict[tuple[str, ...], dict[str, Any]] = {} + for template in cmd_spec.get("url_templates") or []: + names = tuple(sorted(_path_template_keys(template))) + hints[names] = _unpack_kwargs(variants.get(template, base)) + if len({repr(h) for h in hints.values()}) < 2: + return None + return hints + + def _unpack_hint(cmd_spec: dict[str, Any]) -> str: """Extra ``unpack_response`` arguments derived from the response schema.""" key, kind = _response_shape(cmd_spec.get("response_schema")) if kind is None: return "" - if kind == "single": - return ', kind="single"' + if kind in ("single", "tuples", "records"): + return f', kind="{kind}"' return f", rows_key={key!r}, kind={kind!r}" @@ -635,7 +777,7 @@ def _is_scalar_schema(schema: dict[str, Any]) -> bool: def _wrap_scalar_as_value(schema: dict[str, Any]) -> dict[str, Any]: - """Promote a scalar schema to ``{type: object, properties: {value: scalar}}``.""" + """Promote a schema to ``{type: object, properties: {value: schema}}``.""" return { "type": "object", "properties": {"value": schema}, @@ -673,6 +815,7 @@ def _query_dict_construction( creds: dict[str, dict[str, str]], path_params: list[str], provider_name: str, + field_names: dict[str, str] | None = None, ) -> str: """Compose the ``query_dict = {...}`` block emitted in ``aextract_data``. @@ -691,13 +834,13 @@ def _query_dict_construction( The Python source for the ``query_dict`` assignment. """ body_props = (cmd_spec.get("request_body_schema") or {}).get("properties") or {} - excluded = {query_field_name(n) for n in (*path_params, *body_props)} + excluded = {_field_name(field_names, n) for n in (*path_params, *body_props)} range_params = [ p for p in (cmd_spec.get("parameters") or []) if isinstance(p, dict) and p.get("_socrata_op") in {"date_min", "date_max"} ] - excluded.update(query_field_name(p["name"]) for p in range_params) + excluded.update(_field_name(field_names, p["name"]) for p in range_params) if excluded: excluded_literal = ( "{" + ", ".join(repr(name) for name in sorted(excluded)) + "}" @@ -725,7 +868,7 @@ def _query_dict_construction( lines.append(f" if {var}:") lines.append(f" _query_dict[{wire_name!r}] = {var}") if range_params: - lines.extend(_socrata_where_clause_lines(range_params)) + lines.extend(_socrata_where_clause_lines(range_params, field_names)) date_column = next( (p["_socrata_column"] for p in range_params if p.get("_socrata_column")), None, @@ -741,8 +884,23 @@ def _query_dict_construction( and param.get("in", "query") == "query" ): lines.extend( - _list_param_lines(param["name"], param.get("list_style") or "multi") + _list_param_lines( + param["name"], + param.get("list_style") or "multi", + param.get("type") or "string", + ) ) + group_members = list( + dict.fromkeys( + name + for group in cmd_spec.get("required_groups") or [] + for name in group.get("members") or [] + ) + ) + if group_members: + lines.append(f" for _name in {tuple(group_members)!r}:") + lines.append(' if _query_dict.get(_name) in ("", []):') + lines.append(" _query_dict.pop(_name, None)") rename_pairs: list[tuple[str, str]] = [] for param in cmd_spec.get("parameters") or []: if not isinstance(param, dict): @@ -763,13 +921,22 @@ def _query_dict_construction( _LIST_DELIMITERS = {"csv": ",", "space": " ", "pipe": "|"} -def _list_param_lines(wire_name: str, style: str) -> list[str]: +def _list_param_lines( + wire_name: str, style: str, item_type: str = "string" +) -> list[str]: """Emit lines turning the model's comma-joined string into the wire format. - ``multi`` becomes a list (``get_querystring`` repeats the key); the other - styles are re-joined with the delimiter the upstream API expects. + ``multi`` becomes a list (``encode_query`` repeats the key), ``json`` + becomes a JSON array, and the other styles are re-joined with the + delimiter the upstream API expects. """ key = repr(wire_name) + if style == "json": + type_arg = "" if item_type == "string" else f", {item_type!r}" + return [ + f" if isinstance(_query_dict.get({key}), str):", + f" _query_dict[{key}] = json_array(_query_dict[{key}]{type_arg})", + ] lines = [ f" if isinstance(_query_dict.get({key}), str):", f" _items = [i.strip() for i in _query_dict[{key}].split(',') if i.strip()]", @@ -782,14 +949,238 @@ def _list_param_lines(wire_name: str, style: str) -> list[str]: return lines -def _socrata_where_clause_lines(range_params: list[dict[str, Any]]) -> list[str]: +@dataclass +class UrlChoices: + """The URLs of a merged command, as generated code needs them. + + Parameters + ---------- + templates : list of tuple + ``(template, path_names, query_names)`` per URL, most placeholders + first, as ``choose_url_template`` takes them. + names : list of str + Every placeholder and declared query parameter across the URLs. + attributes : dict[str, str] + Wire name to the attribute holding its value. + defaults : dict[str, Any] + Placeholder defaults that must not pick a URL by themselves. + """ + + templates: list[tuple[str, tuple[str, ...], tuple[str, ...]]] + names: list[str] + attributes: dict[str, str] + defaults: dict[str, Any] + + @property + def placeholders(self) -> list[str]: + """Every placeholder name, in first-seen order.""" + return list( + dict.fromkeys(name for _, names, _ in self.templates for name in names) + ) + + +def url_choices_for( + cmd_spec: dict[str, Any], + api_prefix: str, + attributes: dict[str, str], +) -> UrlChoices | None: + """Collect the URLs of a merged command whose placeholders all have attributes. + + ``attributes`` maps each wire name the generated code can read to its + attribute name. URLs with a placeholder outside it (a credential-named or + undeclared segment) are left out, since no value can fill them. ``None`` + when fewer than two URLs remain. A spec written before + ``template_query_params`` existed lets every URL take every query + parameter, as before. + """ + templates = cmd_spec.get("url_templates") or [] + if len(templates) < 2: + return None + params = filter_user_params(cmd_spec.get("parameters") or []) + declared = cmd_spec.get("template_query_params") + legacy = tuple(p["name"] for p in params if p.get("in", "query") != "path") + choices = [] + for template in templates: + path_names = tuple(_path_template_keys(template)) + if not all(name in attributes for name in path_names): + continue + query_names = ( + tuple(n for n in declared.get(template) or () if n in attributes) + if isinstance(declared, dict) + else tuple(n for n in legacy if n in attributes) + ) + choices.append( + (_resolve_url_path(api_prefix, template), path_names, query_names) + ) + if len(choices) < 2: + return None + names = list( + dict.fromkeys( + name + for _, path_names, query_names in choices + for name in (*path_names, *query_names) + ) + ) + placeholders = {name for _, path_names, _ in choices for name in path_names} + defaults = { + p["name"]: p["default"] + for p in params + if p.get("name") in placeholders and p.get("default") is not None + } + return UrlChoices( + templates=choices, + names=names, + attributes={name: attributes[name] for name in names}, + defaults=defaults, + ) + + +def query_params_fields( + cmd_spec: dict[str, Any], provider_name: str, class_name: str +) -> dict[str, str]: + """Each parameter's field name in a command's generated ``QueryParams``.""" + return query_params_field_names( + _query_params_schema(cmd_spec, provider_name)["properties"], class_name + ) + + +def _query_field_names(spec: FetcherCommandSpec) -> dict[str, str]: + """``query_params_fields`` for the ``QueryParams`` class of ``spec``.""" + return query_params_fields( + spec.cmd_spec, spec.provider_name, f"{class_name_from(spec.name)}QueryParams" + ) + + +def _field_name(field_names: dict[str, str] | None, name: str) -> str: + """Return the ``QueryParams`` field that holds parameter ``name``.""" + return (field_names or {}).get(name) or query_field_name(name) + + +def boolean_params(cmd_spec: dict[str, Any]) -> set[str]: + """Names of the command's boolean parameters.""" + return { + p["name"] + for p in cmd_spec.get("parameters") or [] + if isinstance(p, dict) and p.get("name") and p.get("type") == "boolean" + } + + +def _url_template_choices(spec: FetcherCommandSpec) -> UrlChoices | None: + """``url_choices_for`` with the generated ``QueryParams`` fields as attributes.""" + return url_choices_for(spec.cmd_spec, spec.api_prefix, _query_field_names(spec)) + + +def render_choose_url_call( + choices: UrlChoices, owner: str | None, indent: str +) -> list[str]: + """Render a ``choose_url_template(...)`` call. + + Values are read off ``owner`` (``query``, ``self``), or from local + variables named after the attributes when ``owner`` is ``None``. + """ + values = ", ".join( + f"{name!r}: " + + ( + f"getattr({owner}, {choices.attributes[name]!r})" + if owner + else choices.attributes[name] + ) + for name in choices.placeholders + ) + labels = {name: choices.attributes[name] for name in choices.placeholders} + return [ + f"{indent}choose_url_template(", + f"{indent} {tuple(choices.templates)!r},", + f"{indent} {{{values}}},", + f"{indent} {labels!r},", + f"{indent} {choices.defaults!r},", + f"{indent})", + ] + + +def _path_lines( + url_path_template: str, + path_params: list[str], + url_choices: UrlChoices | None, + field_names: dict[str, str] | None = None, + booleans: set[str] | frozenset[str] = frozenset(), +) -> list[str]: + """Emit the ``_path = ...`` assignment for ``aextract_data``. + + A command with several URLs picks one at call time with + ``choose_url_template``; ``_used`` and ``_query_names`` record the names its + placeholders used and the query parameters it declares. A boolean path + value goes through ``wire_value``, so it is sent as ``true`` / ``false``. + """ + if url_choices: + call = render_choose_url_call(url_choices, "query", " ") + call[0] = " _path, _used, _query_names = choose_url_template(" + return call + if path_params: + sub_args = ", ".join( + ( + f"{p}=wire_value(getattr(query, {_field_name(field_names, p)!r}))" + if p in booleans + else f"{p}=getattr(query, {_field_name(field_names, p)!r})" + ) + for p in path_params + ) + return [f" _path = {url_path_template!r}.format({sub_args})"] + return [f" _path = {url_path_template!r}"] + + +def _consumed_path_lines(url_choices: UrlChoices | None) -> list[str]: + """Emit lines dropping what the chosen URL does not send as query parameters. + + That is its own path values, other URLs' parameters it does not declare + (a list URL's ``limit`` default on an item URL), and empty values. + """ + if not url_choices: + return [] + return [ + f" for _name in {tuple(url_choices.names)!r}:", + " if (", + " _name in _used", + " or _name not in _query_names", + ' or _query_dict.get(_name) in ("", [])', + " ):", + " _query_dict.pop(_name, None)", + ] + + +def _url_template_validator(url_choices: UrlChoices) -> str: + """Render a ``QueryParams`` validator rejecting path values that form no URL.""" + call = "\n".join(render_choose_url_call(url_choices, "self", " ")) + return ( + '\n @model_validator(mode="after")\n' + " def _check_url_template(self) -> Any:\n" + ' """Allow only path-parameter combinations that form one of the URLs."""\n' + f"{call}\n" + " return self\n" + ) + + +def _has_json_list_param(cmd_spec: dict[str, Any]) -> bool: + """Whether any query parameter is sent as a JSON-encoded array.""" + return any( + isinstance(p, dict) + and p.get("is_list") + and p.get("list_style") == "json" + and p.get("in", "query") == "query" + for p in filter_user_params(cmd_spec.get("parameters") or []) + ) + + +def _socrata_where_clause_lines( + range_params: list[dict[str, Any]], field_names: dict[str, str] | None = None +) -> list[str]: """Compose runtime lines that fold Socrata range params into ``$where``.""" field_lookups: list[str] = [] for param in range_params: wire_name = param["name"] column = param["_socrata_column"] op = ">=" if param["_socrata_op"] == "date_min" else "<=" - py_field = query_field_name(wire_name) + py_field = _field_name(field_names, wire_name) var = f"_range_{py_field}" field_lookups.append( f" {var} = getattr(query, {py_field!r}, None)\n" @@ -892,7 +1283,9 @@ def generate_fetcher_module(spec: FetcherCommandSpec) -> GeneratedFetcher: fetcher_class = f"{model_name}Fetcher" qp_schema = _query_params_schema(spec.cmd_spec, spec.provider_name) - data_schema = _with_body_field(_data_schema(spec.cmd_spec) or {"type": "object"}) + data_schema = _with_body_field( + _merged_data_schema(spec.cmd_spec) or {"type": "object"} + ) qp_generated = generate_class( qp_schema, @@ -909,6 +1302,20 @@ def generate_fetcher_module(spec: FetcherCommandSpec) -> GeneratedFetcher: creds = credentials_from_command(spec.cmd_spec) path_params = _path_template_keys(spec.cmd_spec.get("url_path") or "") + url_choices = _url_template_choices(spec) + if url_choices: + qp_generated.source = ( + qp_generated.source.rstrip("\n") + + "\n" + + _url_template_validator(url_choices) + ) + qp_generated.imports.update( + { + "from pydantic import model_validator", + "from typing import Any", + "from ....utils import choose_url_template", + } + ) imports = { "import base64", @@ -918,11 +1325,14 @@ def generate_fetcher_module(spec: FetcherCommandSpec) -> GeneratedFetcher: "from openbb_core.provider.abstract.data import Data", "from openbb_core.provider.abstract.fetcher import Fetcher", "from openbb_core.provider.abstract.query_params import QueryParams", - "from openbb_core.provider.utils.helpers import " - "get_async_requests_session, get_querystring", + "from openbb_core.provider.utils.helpers import get_async_requests_session", "from pydantic import BaseModel, Field", - "from ....utils import safe_json_loads, unpack_response", + "from ....utils import encode_query, safe_json_loads, unpack_response", } + if _has_json_list_param(spec.cmd_spec): + imports.add("from ....utils import json_array") + if not url_choices and boolean_params(spec.cmd_spec) & set(path_params): + imports.add("from ....utils import wire_value") imports.update(qp_generated.collect_imports()) imports.update(data_generated.collect_imports()) @@ -934,8 +1344,13 @@ def generate_fetcher_module(spec: FetcherCommandSpec) -> GeneratedFetcher: description = (spec.cmd_spec.get("description") or f"Fetch {spec.name}.").strip() cred_lines = _credential_lookup_lines(creds, spec.provider_name) + field_names = _query_field_names(spec) query_block = _query_dict_construction( - spec.cmd_spec, creds, path_params, spec.provider_name + spec.cmd_spec, + creds, + [] if url_choices else path_params, + spec.provider_name, + field_names, ) header_block = _header_dict_construction(creds, spec.headers) cookie_block = _cookie_dict_construction(creds) @@ -950,6 +1365,7 @@ def generate_fetcher_module(spec: FetcherCommandSpec) -> GeneratedFetcher: method=method, url_path_template=full_url_path, base_url=base_url, + path_params=path_params, cred_lines=cred_lines, query_block=query_block, header_block=header_block, @@ -989,7 +1405,13 @@ def generate_fetcher_module(spec: FetcherCommandSpec) -> GeneratedFetcher: imports=consolidate_imports(imports), column_metadata=_column_metadata_from_data_schema(data_schema), ) - if hint: + template_hints = _template_unpack_hints(spec.cmd_spec, url_choices) + if template_hints: + source = source.replace( + "unpack_response(_payload)", + f"unpack_response(_payload, **{template_hints!r}.get(tuple(sorted(_used)), {{}}))", + ) + elif hint: source = source.replace( "unpack_response(_payload)", f"unpack_response(_payload{hint})" ) @@ -1015,6 +1437,7 @@ def _render_streaming_fetcher_source( method: str, url_path_template: str, base_url: str, + path_params: list[str], cred_lines: list[str], query_block: str, header_block: str, @@ -1041,6 +1464,8 @@ def _render_streaming_fetcher_source( URL path with placeholders intact. base_url : str Upstream API root, no trailing slash. + path_params : list of str + Placeholder names in ``url_path_template``. cred_lines : list of str Credential-extraction source lines. query_block : str @@ -1087,15 +1512,24 @@ def _render_streaming_fetcher_source( parts: list[str] = [] parts.append(f'"""Streaming fetcher for {spec.name} — generated from spec."""') parts.append("") - parts.append("from collections.abc import AsyncIterator") - parts.append("from typing import Any") - parts.append("") - parts.append("import httpx") - parts.append("") - parts.append("from openbb_core.provider.abstract.data import Data") - parts.append("from openbb_core.provider.abstract.fetcher import Fetcher") - parts.append("from openbb_core.provider.abstract.query_params import QueryParams") - parts.append("from openbb_core.provider.utils.helpers import get_querystring") + imports = { + "from collections.abc import AsyncIterator", + "from typing import Any", + "import httpx", + "from openbb_core.provider.abstract.data import Data", + "from openbb_core.provider.abstract.fetcher import Fetcher", + "from openbb_core.provider.abstract.query_params import QueryParams", + "from ....utils import encode_query", + } + url_choices = _url_template_choices(spec) + booleans = boolean_params(spec.cmd_spec) + if _has_json_list_param(spec.cmd_spec): + imports.add("from ....utils import json_array") + if not url_choices and booleans & set(path_params): + imports.add("from ....utils import wire_value") + for cls in qp_classes: + imports.update(cls.imports) + parts.extend(consolidate_imports(imports)) parts.append("") parts.append("") for cls in qp_classes: @@ -1123,10 +1557,20 @@ def _render_streaming_fetcher_source( ) parts.append(aextract_doc) parts.extend(cred_lines) + parts.extend( + _path_lines( + url_path_template, + path_params, + url_choices, + _query_field_names(spec), + booleans, + ) + ) parts.append(query_block) - parts.append(" _query_string = get_querystring(_query_dict, [])") + parts.extend(_consumed_path_lines(url_choices)) + parts.append(" _query_string = encode_query(_query_dict)") parts.append( - f' _url = f"{base_url}{url_path_template}"' + f' _url = f"{base_url}{{_path}}"' ' + ("?" + _query_string if _query_string else "")' ) parts.append(header_block) @@ -1315,6 +1759,9 @@ def _render_fetcher_source( ), has_path_params=has_path_params, has_query_creds=has_query_creds, + url_choices=_url_template_choices(spec), + field_names=_query_field_names(spec), + booleans=boolean_params(spec.cmd_spec), ) fetcher_source_lines = [ @@ -1381,6 +1828,9 @@ def _aextract_body( body_field_names: list[str], has_path_params: bool, has_query_creds: bool, + url_choices: UrlChoices | None = None, + field_names: dict[str, str] | None = None, + booleans: set[str] | frozenset[str] = frozenset(), ) -> list[str]: """Render the body of ``aextract_data`` as a list of source lines. @@ -1408,6 +1858,12 @@ def _aextract_body( Whether the URL has placeholders to substitute. has_query_creds : bool Whether any credential lives in the query string. + url_choices : list, optional + ``_url_template_choices`` output for a command with several URLs. + field_names : dict, optional + Parameter name to ``QueryParams`` field name (``_query_field_names``). + booleans : set of str, optional + Names of boolean parameters. Returns ------- @@ -1415,16 +1871,19 @@ def _aextract_body( Indented lines forming the body of ``aextract_data``. """ lines: list[str] = list(cred_lines) - if has_path_params: - sub_args = ", ".join( - f"{p}=getattr(query, {query_field_name(p)!r})" for p in path_params + lines.extend( + _path_lines( + url_path_template, + path_params if has_path_params else [], + url_choices, + field_names, + booleans, ) - lines.append(f" _path = {url_path_template!r}.format({sub_args})") - else: - lines.append(f" _path = {url_path_template!r}") + ) lines.append("") lines.append(query_block) - lines.append(" _query_string = get_querystring(_query_dict, [])") + lines.extend(_consumed_path_lines(url_choices)) + lines.append(" _query_string = encode_query(_query_dict)") lines.append( f' _url = f"{base_url}{{_path}}" + ("?" + _query_string if _query_string else "")' ) @@ -1437,7 +1896,7 @@ def _aextract_body( body_literal = ( "{" + ", ".join( - f"{name!r}: getattr(query, {query_field_name(name)!r}, None)" + f"{name!r}: getattr(query, {_field_name(field_names, name)!r}, None)" for name in body_field_names ) + "}" diff --git a/cli/openbb_cli/codegen/package_gen.py b/cli/openbb_cli/codegen/package_gen.py index 07d8a9a6d4b..379b92f3df1 100644 --- a/cli/openbb_cli/codegen/package_gen.py +++ b/cli/openbb_cli/codegen/package_gen.py @@ -31,6 +31,7 @@ from openbb_cli.codegen.router_gen import ( GeneratedRouter, GeneratedRouters, generate_routers, + mounted_command_paths, ) from openbb_cli.codegen.test_gen import GeneratedTestModule, generate_provider_tests @@ -68,6 +69,7 @@ class GeneratedPackage: base_url: str = "" commands_by_provider: dict[str, list[str]] = field(default_factory=dict) test_modules: list[GeneratedTestModule] = field(default_factory=list) + command_paths: dict[str, str] = field(default_factory=dict) def write(self) -> Path: """Materialize the project on disk under ``self.root``. @@ -195,7 +197,7 @@ class GeneratedPackage: None, ) model = fetcher.model_name if fetcher else "Returns OBBject" - return dotted, model + return self.command_paths.get(dotted, dotted), model return None def _providers_section(self, ns: str) -> str: @@ -220,8 +222,9 @@ class GeneratedPackage: groups: dict[str, list[tuple[str, str]]] = {} for prov, dotted_paths in self.commands_by_provider.items(): for dotted in sorted(dotted_paths): - top = dotted.split(".", 1)[0] - groups.setdefault(top, []).append((dotted, prov)) + mounted = self.command_paths.get(dotted, dotted) + top = mounted.split(".", 1)[0] + groups.setdefault(top, []).append((mounted, prov)) for top in sorted(groups): lines.append(f"### `obb.{ns}.{top}`\n") for dotted, prov in groups[top]: @@ -647,6 +650,7 @@ def generate_packages( base_url=base_url, commands_by_provider=commands_by_provider, test_modules=test_modules, + command_paths=mounted_command_paths(full_tree), ) return GeneratedPackageSet(packages=[package]) diff --git a/cli/openbb_cli/codegen/post_gen.py b/cli/openbb_cli/codegen/post_gen.py index 3620b375876..fb216c1d78a 100644 --- a/cli/openbb_cli/codegen/post_gen.py +++ b/cli/openbb_cli/codegen/post_gen.py @@ -2,6 +2,7 @@ from __future__ import annotations +import keyword import re from dataclasses import dataclass, field from typing import Any, cast @@ -10,6 +11,12 @@ from openbb_cli.codegen.credentials import ( credentials_from_command, filter_user_params, ) +from openbb_cli.codegen.fetcher_gen import ( + UrlChoices, + boolean_params, + render_choose_url_call, + url_choices_for, +) from openbb_cli.codegen.pydantic_gen import ( GeneratedClass, class_name_from, @@ -83,7 +90,8 @@ def _module_name_from_command(name: str) -> str: safe = "command" if safe[0].isdigit(): safe = f"_{safe}" - return safe.lower() + safe = safe.lower() + return f"{safe}_" if keyword.iskeyword(safe) else safe def _path_template_keys(url_path: str) -> list[str]: @@ -530,6 +538,16 @@ def generate_post_command_module(spec: PostCommandSpec) -> GeneratedPostCommand: full_url_path = _resolve_url_path( spec.api_prefix, spec.cmd_spec.get("url_path") or "" ) + signature_names = {name for name, *_ in params} + url_choices = url_choices_for( + spec.cmd_spec, + spec.api_prefix, + { + p["name"]: safe_field_name(p["name"])[0] + for p in filter_user_params(spec.cmd_spec.get("parameters") or []) + if p.get("name") and safe_field_name(p["name"])[0] in signature_names + }, + ) body_block = _render_body_block( cmd_spec=spec.cmd_spec, body_field=body_field, @@ -541,6 +559,7 @@ def generate_post_command_module(spec: PostCommandSpec) -> GeneratedPostCommand: data_class=data_class, params=params, fixed_headers=spec.headers, + url_choices=url_choices, ) imports = { @@ -549,11 +568,19 @@ def generate_post_command_module(spec: PostCommandSpec) -> GeneratedPostCommand: "from openbb_core.app.model.abstract.error import OpenBBError", "from openbb_core.app.model.obbject import OBBject", "from openbb_core.provider.abstract.data import Data", - "from openbb_core.provider.utils.helpers import " - "get_async_requests_session, get_querystring", + "from openbb_core.provider.utils.helpers import get_async_requests_session", "from pydantic import BaseModel, Field", - "from ....utils import unpack_response", + "from ....utils import encode_query, unpack_response", } + if url_choices: + imports.add("from ....utils import choose_url_template") + elif boolean_params(spec.cmd_spec) & set(path_params): + imports.add("from ....utils import wire_value") + if any( + p.get("is_list") and p.get("list_style") == "json" + for p in filter_user_params(spec.cmd_spec.get("parameters") or []) + ): + imports.add("from ....utils import json_array") if creds: imports.add("from openbb_core.app.model.command_context import CommandContext") imports.update(data_generated.collect_imports()) @@ -631,6 +658,7 @@ def _render_body_block( data_class: str, params: list[tuple[str, str, str | None, bool, Any]], fixed_headers: dict[str, str] | None = None, + url_choices: UrlChoices | None = None, ) -> str: """Render the function body for a POST command. @@ -656,6 +684,8 @@ def _render_body_block( Function parameters. fixed_headers : dict, optional Headers sent with every request (from ``--header`` at spec generation). + url_choices : UrlChoices, optional + The URLs of a merged command, picked between at call time. Returns ------- @@ -683,19 +713,47 @@ def _render_body_block( lines: list[str] = [] lines.extend(cred_lines) - if path_params: - sub_args = ", ".join(f"{p}={p}" for p in path_params) + if url_choices: + call = render_choose_url_call(url_choices, None, " ") + call[0] = " _path, _used, _query_names = choose_url_template(" + lines.extend(call) + elif path_params: + booleans = boolean_params(cmd_spec) + sub_args = ", ".join( + f"{p}=wire_value({p})" if p in booleans else f"{p}={p}" for p in path_params + ) lines.append(f" _path = {url_path_template!r}.format({sub_args})") else: lines.append(f" _path = {url_path_template!r}") + json_lists = { + p["name"]: p.get("type") or "string" + for p in filter_user_params(cmd_spec.get("parameters") or []) + if p.get("is_list") and p.get("list_style") == "json" + } lines.append(" _query_dict: dict[str, Any] = {}") for name in query_field_names: wire = wire_by_safe.get(name, name) - if wire in path_params or name in path_params: + if not url_choices and (wire in path_params or name in path_params): continue lines.append(f" if {name} is not None:") - lines.append(f" _query_dict[{wire!r}] = {name}") + if wire in json_lists: + type_arg = "" if json_lists[wire] == "string" else f", {json_lists[wire]!r}" + lines.append( + f" _value = json_array({name} if isinstance({name}, str) " + f"else _json.dumps(list({name})){type_arg})" + ) + lines.append(" if _value is not None:") + lines.append(f" _query_dict[{wire!r}] = _value") + else: + lines.append(f" _query_dict[{wire!r}] = {name}") + if url_choices: + lines.append(f" for _name in {tuple(url_choices.names)!r}:") + lines.append( + " if _name in _used or _name not in _query_names " + 'or _query_dict.get(_name) in ("", []):' + ) + lines.append(" _query_dict.pop(_name, None)") for canonical, info in creds.items(): if info["in"] != "query": continue @@ -703,7 +761,7 @@ def _render_body_block( var = f"_cred_{canonical}" lines.append(f" if {var}:") lines.append(f" _query_dict[{wire_name!r}] = {var}") - lines.append(" _query_string = get_querystring(_query_dict, [])") + lines.append(" _query_string = encode_query(_query_dict)") lines.append( f' _url = f"{base_url}{{_path}}" + ("?" + _query_string if _query_string else "")' ) diff --git a/cli/openbb_cli/codegen/project_gen.py b/cli/openbb_cli/codegen/project_gen.py index 6625d11e0f3..eaee01630c6 100644 --- a/cli/openbb_cli/codegen/project_gen.py +++ b/cli/openbb_cli/codegen/project_gen.py @@ -100,7 +100,7 @@ select = ["E", "F", "W", "I", "B", "UP", "D"] ignore = [ "D100", "D101", "D102", "D103", "D104", "D105", "D107", "D200", "D205", "D212", "D401", "D415", - "E501", "B008", + "E501", "E741", "B008", ] [tool.ruff.lint.pydocstyle] diff --git a/cli/openbb_cli/codegen/pydantic_gen.py b/cli/openbb_cli/codegen/pydantic_gen.py index 82673d11848..8073c1cf5f6 100644 --- a/cli/openbb_cli/codegen/pydantic_gen.py +++ b/cli/openbb_cli/codegen/pydantic_gen.py @@ -565,6 +565,87 @@ def render_function_docstring( return "\n".join(lines) +_BUILTIN_TYPE_NAMES = ( + "list", + "dict", + "set", + "tuple", + "str", + "int", + "float", + "bool", + "bytes", +) + + +_QUOTED = re.compile(r"'(?:[^'\\]|\\.)*'|\"(?:[^\"\\]|\\.)*\"") + + +def _shadowed_builtins(properties: dict[str, Any], class_name: str) -> set[str]: + """Builtin type names that a field would shadow inside its class's annotations. + + A field named ``list`` binds ``list`` in the class body, so a later + ``list[...]`` annotation (its own included) fails when the class is built. + Returns the builtin names some field is called and some annotation uses + outside a string (``Literal['list']`` uses none). + """ + names = {safe_field_name(raw)[0] for raw in properties} | { + query_field_name(raw) for raw in properties + } + candidates = names & set(_BUILTIN_TYPE_NAMES) + if not candidates: + return set() + annotations = " ".join( + schema_to_type( + prop if isinstance(prop, dict) else {}, + parent_class_name=class_name, + field_name=safe_field_name(raw)[0], + nested_classes=[], + imports=set(), + ) + for raw, prop in properties.items() + ) + annotations = _QUOTED.sub("''", annotations) + return {name for name in candidates if re.search(rf"\b{name}\b", annotations)} + + +def _unique_field_names( + properties: dict[str, Any], class_name: str, *, query_params: bool +) -> dict[str, str]: + """Map each property name to a field name no other property of the class uses. + + Names are made safe the usual way (``query_field_name`` for query + parameters), and a builtin some annotation needs gets a ``_`` suffix. When + two properties land on one name (``@id`` and ``id``), the property already + spelled that way keeps it and the others get ``_`` suffixes. + """ + shadowed = _shadowed_builtins(properties, class_name) + wanted: dict[str, str] = {} + for raw in properties: + safe = query_field_name(raw) if query_params else safe_field_name(raw)[0] + wanted[raw] = f"{safe}_" if safe in shadowed else safe + taken: set[str] = set() + out: dict[str, str] = {} + for raw in sorted(properties, key=lambda r: wanted[r] != r): + name = wanted[raw] + while name in taken: + name = f"{name}_" + taken.add(name) + out[raw] = name + return {raw: out[raw] for raw in properties} + + +def query_params_field_names( + properties: dict[str, Any], class_name: str +) -> dict[str, str]: + """Map each parameter to its field name in a ``QueryParams`` class. + + The names ``generate_class`` gives the fields of ``class_name`` built from + ``properties``, for code that reads those fields back. + """ + return _unique_field_names(properties, class_name, query_params=True) + + def generate_class( schema: dict[str, Any], *, @@ -581,12 +662,15 @@ def generate_class( doc_fields: list[tuple[str, str, str | None, bool, Any, bool]] = [] optional_object_fields: list[str] = [] multiple_items: dict[str, dict[str, Any]] = {} + field_names: dict[str, str] = {} + unique_names = _unique_field_names( + properties, class_name, query_params=base_class == "QueryParams" + ) for raw_name, prop_schema in properties.items(): - safe_name, needs_alias = safe_field_name(raw_name) - if base_class == "QueryParams": - safe_name = query_field_name(raw_name) - needs_alias = safe_name != raw_name + safe_name = unique_names[raw_name] + needs_alias = safe_name != raw_name + field_names[raw_name] = safe_name annotation = schema_to_type( prop_schema if isinstance(prop_schema, dict) else {}, parent_class_name=class_name, @@ -687,6 +771,23 @@ def generate_class( " return values" ) + required_groups = [ + group + for group in schema.get("x-required-groups") or [] + if _group_maps_to_distinct_fields(group, field_names) + ] + if required_groups: + imports.add("from pydantic import model_validator") + imports.add("from typing import Any") + defaults = { + field_names[raw]: prop["default"] + for raw, prop in properties.items() + if isinstance(prop, dict) and prop.get("default") is not None + } + body_lines.append( + _render_required_groups_validator(required_groups, field_names, defaults) + ) + summary = docstring or class_name doc_block = _render_class_docstring(summary, doc_fields) @@ -703,6 +804,99 @@ def generate_class( ) +def _group_maps_to_distinct_fields( + group: dict[str, Any], field_names: dict[str, str] +) -> bool: + """Whether every name in a required group is a field of its own. + + A name with no field, or two names that collapse to one field (``Symbol`` + and ``symbol``), would make the group impossible to satisfy. + """ + alternatives = group.get("alternatives") or [] + names = {name for alt in alternatives for name in alt} + names.update(name for name in group.get("members") or [] if name in field_names) + if not alternatives or any(name not in field_names for name in names): + return False + return len({field_names[name] for name in names}) == len(names) + + +def _render_required_groups_validator( + groups: list[dict[str, Any]], + field_names: dict[str, str], + defaults: dict[str, Any] | None = None, +) -> str: + """Render an ``after`` model validator enforcing ``oneOf`` / ``anyOf`` groups. + + Parameters + ---------- + groups : list[dict] + Required groups in the spec form (``combinator``, ``alternatives``, + ``members``, ``required``), naming properties by their schema name. + field_names : dict[str, str] + Schema property name to generated field name. + defaults : dict[str, Any], optional + Field name to default value. An optional group is only checked when a + member is passed, and a member left at its default was not passed. + + Returns + ------- + str + The indented validator method source. ``None``, ``""`` and ``[]`` + count as not passed. + """ + defaults = defaults or {} + lines = [ + '\n @model_validator(mode="after")', + " def _check_required_groups(self) -> Any:", + ' """Enforce the parameter combinations the API requires."""', + ] + for group in groups: + alternatives = tuple( + tuple(field_names[name] for name in alt) for alt in group["alternatives"] + ) + exactly_one = group.get("combinator") == "oneOf" + described = " | ".join( + alt[0] if len(alt) == 1 else f"({', '.join(alt)})" for alt in alternatives + ) + message = f"Pass {'exactly' if exactly_one else 'at least'} one of: {described}" + indent = " " + if not group.get("required", True): + members = tuple( + field_names[name] + for name in group.get("members") or [] + if name in field_names + ) + if any(name in defaults for name in members): + pairs = tuple((name, defaults.get(name)) for name in members) + lines.extend( + [ + f"{indent}if any(", + f"{indent} getattr(self, _name) not in (None, '', [])", + f"{indent} and getattr(self, _name) != _default", + f"{indent} for _name, _default in {pairs!r}", + f"{indent}):", + ] + ) + else: + lines.append( + f"{indent}if any(getattr(self, _name) not in (None, '', []) " + f"for _name in {members!r}):" + ) + indent += " " + lines.extend( + [ + f"{indent}_satisfied = sum(", + f"{indent} all(getattr(self, _name) not in (None, '', []) for _name in _names)", + f"{indent} for _names in {alternatives!r}", + f"{indent})", + f"{indent}if _satisfied {'!= 1' if exactly_one else '< 1'}:", + f"{indent} raise ValueError({message!r})", + ] + ) + lines.append(" return self") + return "\n".join(lines) + + def consolidate_imports(imports: set[str]) -> list[str]: """Merge multiple ``from X import A`` / ``from X import B`` into one line. diff --git a/cli/openbb_cli/codegen/router_gen.py b/cli/openbb_cli/codegen/router_gen.py index 648eeffa903..78240946f84 100644 --- a/cli/openbb_cli/codegen/router_gen.py +++ b/cli/openbb_cli/codegen/router_gen.py @@ -97,6 +97,36 @@ def _model_name_for(path: str) -> str: ) +def mounted_command_paths(root: NamespaceNode) -> dict[str, str]: + """Map each command's dotted spec path to the path it mounts at under ``obb``. + + Segments are normalized the same way as router modules and functions, and a + command that is also a namespace mounts on its own router, named after itself. + + Parameters + ---------- + root : NamespaceNode + The synthetic root node returned by ``build_namespace_tree``. + + Returns + ------- + dict[str, str] + ``{dotted_spec_path: dotted_mounted_path}`` for every command in the tree. + """ + out: dict[str, str] = {} + pending = list(root.children.values()) + while pending: + node = pending.pop() + pending.extend(node.children.values()) + if node.cmd_spec is None: + continue + parts = [_safe_segment(p) for p in node.full_path.split(".") if p] + if node.is_namespace: + parts.append(_safe_segment(node.name)) + out[node.full_path] = ".".join(parts) + return out + + def generate_routers( root: NamespaceNode, *, diff --git a/cli/openbb_cli/codegen/test_gen.py b/cli/openbb_cli/codegen/test_gen.py index 89467eb354b..0dde8960e2c 100644 --- a/cli/openbb_cli/codegen/test_gen.py +++ b/cli/openbb_cli/codegen/test_gen.py @@ -2,14 +2,17 @@ from __future__ import annotations +import keyword +import re from dataclasses import dataclass from datetime import UTC +from itertools import islice, product from typing import TYPE_CHECKING, Any -from openbb_cli.codegen.pydantic_gen import safe_field_name +from openbb_cli.codegen.pydantic_gen import query_field_name if TYPE_CHECKING: - from openbb_cli.codegen.fetcher_gen import GeneratedFetcher + from openbb_cli.codegen.fetcher_gen import GeneratedFetcher, UrlChoices _STANDARD_HEADER_REDACTIONS: tuple[tuple[str, str | None], ...] = ( @@ -112,7 +115,11 @@ def generate_provider_tests( for f in sorted(fetchers, key=lambda x: x.fetcher_class): dotted = _dotted_for_fetcher(f, commands_by_dotted) cmd_spec = commands_by_dotted.get(dotted, {}) if dotted else {} - params = _derive_test_params(cmd_spec, provider_name) + params = _derive_test_params( + cmd_spec, + provider_name, + class_name=f.fetcher_class.removesuffix("Fetcher") + "QueryParams", + ) if params is None: continue testable.append((f, params)) @@ -214,14 +221,12 @@ def _dotted_for_fetcher( def _normalize_to_module(dotted: str) -> str: """Match ``fetcher_gen._module_name_from_command`` exactly.""" - import re - safe = re.sub(r"[^0-9a-zA-Z]+", "_", dotted).strip("_").lower() if not safe: safe = "command" if safe[0].isdigit(): safe = f"_{safe}" - return safe + return f"{safe}_" if keyword.iskeyword(safe) else safe _DATE_PARAM_NAMES: frozenset[str] = frozenset( @@ -246,10 +251,24 @@ def _is_date_param(name: str) -> bool: def _derive_test_params( - cmd_spec: dict[str, Any], provider_name: str + cmd_spec: dict[str, Any], provider_name: str, class_name: str = "QueryParams" ) -> dict[str, Any] | None: - """Build a kwargs dict for the command's testable params, or ``None``.""" + """Build a kwargs dict for the command's testable params, or ``None``. + + Keys are the generated ``QueryParams`` field names, the attribute names + ``Fetcher.test`` reads back from the validated query. The params satisfy + the command's required groups and, for a command with several URLs, form + one of them; when that is impossible the test is skipped. + """ out: dict[str, Any] = {} + params_by_name: dict[str, dict[str, Any]] = {} + heuristic: set[str] = set() + placeholders = { + name + for template in cmd_spec.get("url_templates") + or [cmd_spec.get("url_path") or ""] + for name in re.findall(r"\{([^}]+)\}", template) + } for raw in cmd_spec.get("parameters") or []: if not isinstance(raw, dict): continue @@ -259,30 +278,190 @@ def _derive_test_params( param_providers = raw.get("providers") or [] if param_providers and provider_name not in param_providers: continue - field_name, _ = safe_field_name(name) + params_by_name[name] = raw if raw.get("required"): value = _spec_supplied_value(raw) if value is None: return None - out[field_name] = value - elif _is_date_param(name): - out[field_name] = _refresh_date_shape(name, "1970-01-01") - return out + out[name] = value + elif ( + _is_date_param(name) + and not raw.get("choices") + and raw.get("in", "query") != "path" + and name not in placeholders + ): + out[name] = _refresh_date_shape(name, "1970-01-01") + heuristic.add(name) + groups = cmd_spec.get("required_groups") or [] + satisfied = _satisfy_groups(groups, out, params_by_name, heuristic) + if satisfied is None: + return None + formed = _satisfy_url_templates(cmd_spec, satisfied, params_by_name) + if formed is None: + return None + from openbb_cli.codegen.fetcher_gen import query_params_fields + + field_names = query_params_fields( + {**cmd_spec, "parameters": list(params_by_name.values())}, + provider_name, + class_name, + ) + return { + field_names.get(name) or query_field_name(name): value + for name, value in formed.items() + } + + +def _is_present(out: dict[str, Any], name: str) -> bool: + """Whether ``out`` passes a value for ``name``, by the validator's rule.""" + return out.get(name) not in (None, "", []) + + +def _group_holds(group: dict[str, Any], out: dict[str, Any]) -> bool: + """Whether ``out`` passes the generated ``_check_required_groups`` for ``group``.""" + if not group.get("required", True) and not any( + _is_present(out, name) for name in group.get("members") or [] + ): + return True + met = sum( + all(_is_present(out, name) for name in alt) + for alt in group.get("alternatives") or [] + ) + return met == 1 if group.get("combinator") == "oneOf" else met >= 1 + + +_MAX_GROUP_COMBINATIONS = 512 + + +def _satisfy_groups( + groups: list[dict[str, Any]], + out: dict[str, Any], + params_by_name: dict[str, dict[str, Any]], + heuristic: set[str], +) -> dict[str, Any] | None: + """Return ``out`` changed so every required group passes, or ``None``. + + Optional groups set off only by params the date heuristic added are + disarmed by removing those params. Then every combination of one + alternative per group (an optional group may also be left out) is tried in + order, up to a bound: missing values come from the spec, and for ``oneOf`` + the params only unchosen alternatives need are removed. Required params + are never removed. + """ + if all(_group_holds(group, out) for group in groups): + return out + base = dict(out) + for group in groups: + if group.get("required", True) or _group_holds(group, base): + continue + triggered = [n for n in group.get("members") or [] if _is_present(base, n)] + if triggered and set(triggered) <= heuristic: + for name in triggered: + base.pop(name, None) + if all(_group_holds(group, base) for group in groups): + return base + required = {name for name, raw in params_by_name.items() if raw.get("required")} + options = [ + list(group.get("alternatives") or []) + + ([] if group.get("required", True) else [None]) + for group in groups + ] + for combo in islice(product(*options), _MAX_GROUP_COMBINATIONS): + candidate = _fill( + base, [n for alt in combo if alt for n in alt], params_by_name + ) + if candidate is None: + continue + chosen = {name for alt in combo if alt for name in alt} + for group, alt in zip(groups, combo, strict=True): + if alt is None or group.get("combinator") != "oneOf": + continue + for other in group.get("alternatives") or []: + for name in other: + if name not in chosen and name not in required: + candidate.pop(name, None) + if all(_group_holds(group, candidate) for group in groups): + return candidate + return None + + +def _fill( + out: dict[str, Any], + names: list[str], + params_by_name: dict[str, dict[str, Any]], +) -> dict[str, Any] | None: + """Copy ``out`` with spec-supplied values for any of ``names`` it lacks.""" + candidate = dict(out) + for name in names: + if _is_present(candidate, name): + continue + raw = params_by_name.get(name) + value = _spec_supplied_value(raw) if raw is not None else None + if value is None: + return None + candidate[name] = value + return candidate + + +def _satisfy_url_templates( + cmd_spec: dict[str, Any], + out: dict[str, Any], + params_by_name: dict[str, dict[str, Any]], +) -> dict[str, Any] | None: + """Make ``out`` form one of a merged command's URLs, as its validator checks. + + When the params form none, the first URL whose placeholders can all be + filled from the spec is filled; ``None`` when no URL can be. + """ + from openbb_cli.codegen.fetcher_gen import url_choices_for + + choices = url_choices_for(cmd_spec, "", {name: name for name in params_by_name}) + if choices is None or _forms_url(choices, out): + return out + for _, path_names, _ in choices.templates: + candidate = _fill(out, list(path_names), params_by_name) + if candidate is not None and _forms_url(choices, candidate): + return candidate + return None + + +def _forms_url(choices: UrlChoices, out: dict[str, Any]) -> bool: + """Whether ``out`` passes the generated ``_check_url_template``.""" + from openbb_cli.dispatchers._unpack import choose_url_template + + values = { + name: out.get(name, choices.defaults.get(name)) for name in choices.placeholders + } + try: + choose_url_template(choices.templates, values, None, choices.defaults) + except ValueError: + return False + return True def _spec_supplied_value(param: dict[str, Any]) -> Any: - """Return a value the spec itself vouches for, or ``None`` to abort the test.""" - raw_value: Any = None - if param.get("example") is not None: - raw_value = param["example"] - elif param.get("default") is not None: - raw_value = param["default"] - else: - choices = param.get("choices") or [] - if choices: - raw_value = choices[0] + """Return a value the spec itself vouches for, or ``None`` to abort the test. + + The example wins, then the default, then the first choice; when the param + declares ``choices``, an example or default outside them is skipped. + """ + choices = param.get("choices") or [] + raw_value: Any = next( + ( + value + for value in (param.get("example"), param.get("default")) + if value is not None and (not choices or value in choices) + ), + choices[0] if choices else None, + ) if raw_value is None: return None + if ( + isinstance(raw_value, list) + and param.get("is_list") + and param.get("in", "query") == "query" + ): + raw_value = ",".join(str(item) for item in raw_value) return _refresh_date_shape(param.get("name") or "", raw_value) diff --git a/cli/openbb_cli/dispatchers/_unpack.py b/cli/openbb_cli/dispatchers/_unpack.py index 7cf762cf14a..cfdb4934c02 100644 --- a/cli/openbb_cli/dispatchers/_unpack.py +++ b/cli/openbb_cli/dispatchers/_unpack.py @@ -1,4 +1,7 @@ -"""Shared response unwrapping used by both the HTTP dispatcher and codegen.""" +"""Runtime helpers shared by the HTTP dispatcher and generated code. + +Response unwrapping, plus the query-string encoding generated fetchers use. +""" from __future__ import annotations @@ -7,6 +10,132 @@ import re as _re from typing import Any _BARE_ASTERISK = _re.compile(r":\s*\*\s*(?=[,}\]])") +_QUERY_SAFE = ",:/@!$'()*;?" + + +def encode_query(items: dict[str, Any]) -> str: + """Build a URL query string from ``items``. + + ``None`` values are dropped, list values repeat the key, and booleans are + sent as ``true`` / ``false``. Characters that + change how a query string parses (``&``, ``=``, ``+``, ``#``, ``%``, + spaces, quotes, brackets) are percent-encoded; commas, colons and slashes + stay literal, so delimited lists and times are sent as written. + """ + from urllib.parse import quote, urlencode + + return urlencode( + { + key: ( + [wire_value(item) for item in value] + if isinstance(value, (list, tuple)) + else wire_value(value) + ) + for key, value in items.items() + if value is not None + }, + doseq=True, + safe=_QUERY_SAFE, + quote_via=quote, + ) + + +def wire_value(value: Any) -> Any: + """Return ``value`` as it goes on the wire: booleans as ``true`` / ``false``.""" + if isinstance(value, bool): + return "true" if value else "false" + return value + + +_PLACEHOLDER = _re.compile(r"\{([^}]+)\}") + + +def choose_url_template( + templates: Any, + values: dict[str, Any], + labels: dict[str, str] | None = None, + defaults: dict[str, Any] | None = None, +) -> tuple[str, list[str], list[str]]: + """Pick the URL template that fits the path values passed, and fill it in. + + ``templates`` lists ``(template, path_names, query_names)`` from most to + fewest placeholders: ``path_names`` are the template's placeholders and + ``query_names`` the query parameters that URL declares. A value counts as + passed when it is not ``None`` or ``""`` and differs from its entry in + ``defaults``. A template fits when every placeholder has a value (passed or + default), every other passed path value is one of its query parameters, + and at least one of its placeholders that not every template shares was + passed (or it has none of those): a default can complete a URL the caller + picked, but never picks or blocks one by itself. ``labels`` renames values + in the error message. + + Returns the filled-in path, the names its placeholders used, and its query + parameters. Raises ``ValueError`` listing the accepted combinations when + no template fits. + """ + defaults = defaults or {} + available = {name for name, value in values.items() if value not in (None, "")} + passed = { + name + for name in available + if not (name in defaults and values[name] == defaults[name]) + } + shared = ( + set.intersection(*(set(names) for _, names, _ in templates)) + if templates + else set() + ) + for template, path_names, query_names in templates: + path = set(path_names) + distinct = path - shared + if ( + path <= available + and passed - path <= set(query_names) + and (not distinct or distinct & passed) + ): + filled = _PLACEHOLDER.sub( + lambda m: str(wire_value(values[m.group(1)])), template + ) + return filled, list(path_names), list(query_names) + label = (labels or {}).get + options = " | ".join( + dict.fromkeys( + " + ".join(label(name, name) for name in path_names) or "none" + for _, path_names, _ in templates + ) + ) + given = ", ".join(sorted(label(name, name) for name in passed)) or "none" + raise ValueError( + f"Path parameters ({given}) do not form a URL. Pass one of: {options}" + ) + + +def json_array(value: str, item_type: str = "string") -> str | None: + """Encode a comma-separated value, or a JSON array string, as a compact JSON array. + + Comma-separated items are converted to ``item_type`` (``"integer"``, + ``"number"`` or ``"boolean"``; anything else stays a string). A JSON array + string is sent as written. Empty input returns ``None`` so it is not sent. + """ + text = value.strip() + if not text: + return None + if text.startswith("["): + try: + items = _json.loads(text) + except ValueError: + items = None + if isinstance(items, list): + return _json.dumps(items, separators=(",", ":")) + convert = { + "integer": int, + "number": float, + "boolean": lambda item: item.lower() == "true", + }.get(item_type, str) + return _json.dumps( + [convert(item.strip()) for item in text.split(",") if item.strip()], + separators=(",", ":"), + ) def safe_json_loads(text: str) -> Any: @@ -29,6 +158,13 @@ def _unpack_by_hint( payload: Any, rows_key: str | None, kind: str ) -> tuple[list[dict[str, Any]], dict[str, Any]] | None: """Unpack as the response schema says; ``None`` if the payload doesn't fit.""" + if kind in ("tuples", "records"): + row_type = list if kind == "tuples" else dict + if not isinstance(payload, list) or not all( + isinstance(v, row_type) for v in payload + ): + return None + return ([{"value": v} for v in payload] if kind == "tuples" else payload), {} if not isinstance(payload, dict): return None if kind == "single": @@ -55,7 +191,7 @@ def unpack_response( ) -> tuple[list[dict[str, Any]], dict[str, Any]]: """Split a raw API payload into (rows, metadata). - ``kind`` (``"list"``, ``"map"`` or ``"single"``) and ``rows_key`` come from + ``kind`` (``"list"``, ``"map"``, ``"single"``, ``"tuples"`` or ``"records"``) and ``rows_key`` come from the response schema when the caller knows it; otherwise the payload shape is guessed. """ diff --git a/cli/openbb_cli/dispatchers/http.py b/cli/openbb_cli/dispatchers/http.py index 7a795fd2aa6..0cae7ac0f07 100644 --- a/cli/openbb_cli/dispatchers/http.py +++ b/cli/openbb_cli/dispatchers/http.py @@ -15,7 +15,12 @@ import httpx from openbb_core.app.model.abstract.warning import OpenBBWarning from openbb_cli.auth import AuthContext, AuthDecision, AuthHook -from openbb_cli.dispatchers._unpack import unpack_response +from openbb_cli.dispatchers._unpack import ( + choose_url_template, + json_array, + unpack_response, + wire_value, +) from openbb_cli.dispatchers.openapi_schema import ( PROVIDER_SECTION_SPLIT_RE, PROVIDER_TAG_RE, @@ -489,10 +494,64 @@ def _wrap_plotly_figure( ) -def _shape_result(payload: Any) -> Any: +def _returns_tuples(cmd_spec: dict[str, Any] | None) -> bool: + """Whether a command's response is an array of arrays (positional rows).""" + schema = (cmd_spec or {}).get("response_schema") + if not isinstance(schema, dict) or schema.get("type") != "array": + return False + items = schema.get("items") + return isinstance(items, dict) and ( + items.get("type") == "array" or "items" in items + ) + + +def _check_required_groups(cmd_spec: dict[str, Any], params: dict[str, Any]) -> None: + """Raise ``ValueError`` when ``params`` break a command's required groups. + + Same rule as the generated ``_check_required_groups`` validator: ``None``, + ``""`` and ``[]`` count as not passed, and an optional group only applies + when one of its members is passed with a value other than its default. + """ + defaults = { + p["name"]: p["default"] + for p in command_parameters(cmd_spec) + if isinstance(p, dict) and p.get("name") and p.get("default") is not None + } + + def present(name: str) -> bool: + return params.get(name) not in (None, "", []) + + def changed(name: str) -> bool: + return present(name) and ( + name not in defaults or params[name] != defaults[name] + ) + + for group in cmd_spec.get("required_groups") or []: + if not group.get("required", True) and not any( + changed(name) for name in group.get("members") or [] + ): + continue + alternatives = group.get("alternatives") or [] + met = sum(all(present(name) for name in alt) for alt in alternatives) + exactly_one = group.get("combinator") == "oneOf" + if (met != 1) if exactly_one else (met < 1): + described = " | ".join( + alt[0] if len(alt) == 1 else f"({', '.join(alt)})" + for alt in alternatives + ) + raise ValueError( + f"Pass {'exactly' if exactly_one else 'at least'} one of: {described}" + ) + + +def _shape_result(payload: Any, cmd_spec: dict[str, Any] | None = None) -> Any: """Apply the same envelope unwrap codegen does, then return a tidy result.""" if not isinstance(payload, (dict, list)): return payload + if _returns_tuples(cmd_spec) and isinstance(payload, list): + return [ + row.get("value", row) for row in unpack_response(payload, kind="tuples")[0] + ] rows, metadata = unpack_response(payload) if not rows and not metadata: return payload @@ -557,8 +616,13 @@ class HttpDispatcher: When multiple URL templates exist for the command (overloads merged at spec-build time), pick the one with the most path placeholders that are - all satisfied by ``params``; fall back to the shortest template otherwise. + all satisfied by ``params`` and that takes every other path value passed + as a query parameter. Path values that fit no template raise + ``ValueError`` instead of being sent as query parameters. """ + _check_required_groups( + (self._spec_doc.get("commands") or {}).get(command) or {}, params + ) templates = self._command_url_paths.get(command) if not templates: return self._url_for(command), self._apply_param_transforms( @@ -566,6 +630,8 @@ class HttpDispatcher: ) ordered = sorted(templates, key=lambda t: -t.count("{")) + if len(ordered) > 1: + return self._resolve_merged_url(command, ordered, params) chosen: str | None = None for template in ordered: placeholders = _PATH_TEMPLATE_RE.findall(template) @@ -586,7 +652,7 @@ class HttpDispatcher: value = params.get(key) if value is None: return match.group(0) - return str(value) + return str(wire_value(value)) path = _PATH_TEMPLATE_RE.sub(_substitute, chosen) remaining = {k: v for k, v in params.items() if k not in consumed} @@ -594,6 +660,58 @@ class HttpDispatcher: command, remaining ) + def _resolve_merged_url( + self, command: str, templates: list[str], params: dict[str, Any] + ) -> tuple[str, dict[str, Any]]: + """Resolve a merged command's URL the way its generated fetcher does. + + Path values that fit no template raise ``ValueError``; the chosen URL's + own path values, and the other URLs' parameters it does not declare, + are left out of the query. A spec without ``template_query_params`` + (built before it existed) lets every URL take any other parameter as a + query parameter, as such specs always did. + """ + cmd_spec = (self._spec_doc.get("commands") or {}).get(command) or {} + spec_params = [p for p in command_parameters(cmd_spec) if isinstance(p, dict)] + declared = cmd_spec.get("template_query_params") + names = [p["name"] for p in spec_params if p.get("name")] + + def query_names_for(template: str, keys: tuple[str, ...]) -> tuple[str, ...]: + if isinstance(declared, dict): + return tuple(declared.get(template) or ()) + return tuple(name for name in names if name not in keys) + + choices = [ + (template, keys, query_names_for(template, keys)) + for template in templates + for keys in [tuple(_PATH_TEMPLATE_RE.findall(template))] + ] + placeholders = {name for _, keys, _ in choices for name in keys} + defaults = { + p["name"]: ( + p["default"] + if p.get("default") is not None + else (False if p.get("type") == "boolean" else None) + ) + for p in spec_params + if p.get("name") in placeholders + } + path, used, query_names = choose_url_template( + choices, + {name: params.get(name) for name in placeholders}, + None, + {k: v for k, v in defaults.items() if v is not None}, + ) + url_names = placeholders | {n for _, _, names in choices for n in names} + remaining = { + k: v + for k, v in params.items() + if k not in used and not (k in url_names and k not in query_names) + } + return f"{self._base_url}{path}", self._apply_param_transforms( + command, remaining + ) + def _date_snapshot_context(self, request: Request) -> tuple[str | None, int | None]: """Detect the rows-from-N-most-recent-dates branch for ``limit``.""" cmd_spec = (self._spec_doc.get("commands") or {}).get(request.command) or {} @@ -629,8 +747,8 @@ class HttpDispatcher: timestamp=timestamp, duration_ns=duration_ns, ) - shaped = _shape_result(payload) cmd_spec = (self._spec_doc.get("commands") or {}).get(command) or {} + shaped = _shape_result(payload, cmd_spec) column_types = _row_column_types(cmd_spec) column_metadata = _row_column_metadata(cmd_spec) @@ -750,6 +868,7 @@ class HttpDispatcher: cmd_spec = (self._spec_doc.get("commands") or {}).get(command) or {} locations: dict[str, tuple[str, str]] = {} delimiters: dict[str, str] = {} + json_lists: dict[str, str] = {} for p in command_parameters(cmd_spec): if isinstance(p, dict) and p.get("name"): spec_name = p["name"] @@ -763,6 +882,8 @@ class HttpDispatcher: locations[key] = (loc, spec_name) if p.get("is_list") and delimiter: delimiters[key] = delimiter + if p.get("is_list") and p.get("list_style") == "json": + json_lists[key] = p.get("type") or "string" query: dict[str, Any] = {} body: dict[str, Any] = {} headers: dict[str, Any] = {} @@ -777,6 +898,15 @@ class HttpDispatcher: out_value = value if name in delimiters and isinstance(value, (list, tuple)): out_value = delimiters[name].join(str(v) for v in value) + elif name in json_lists and isinstance(value, (list, tuple)): + if len(value) == 1 and isinstance(value[0], str): + out_value = json_array(value[0], json_lists[name]) + else: + out_value = json.dumps(list(value), separators=(",", ":")) + elif name in json_lists and isinstance(value, str): + out_value = json_array(value, json_lists[name]) + if name in json_lists and out_value is None: + continue query[name] = out_value return query, body, headers diff --git a/cli/openbb_cli/dispatchers/openapi_schema.py b/cli/openbb_cli/dispatchers/openapi_schema.py index aa025fff598..36e8e28b2c5 100644 --- a/cli/openbb_cli/dispatchers/openapi_schema.py +++ b/cli/openbb_cli/dispatchers/openapi_schema.py @@ -121,6 +121,19 @@ def deref_parameter(spec: dict[str, Any], param: dict[str, Any]) -> dict[str, An schema = param.get("schema") if isinstance(schema, dict): param = {**param, "schema": deref_schema(spec, schema)} + content = param.get("content") + if isinstance(content, dict): + param = { + **param, + "content": { + media_type: ( + {**media, "schema": deref_schema(spec, media["schema"])} + if isinstance(media, dict) and isinstance(media.get("schema"), dict) + else media + ) + for media_type, media in content.items() + }, + } return param @@ -315,7 +328,7 @@ def merge_allof(node: Any, max_depth: int = 32) -> Any: for member in mergeable: for name, subschema in (member.get("properties") or {}).items(): properties.setdefault(name, subschema) - for name in member.get("required") or []: + for name in _required_names(member): if name not in required: required.append(name) @@ -324,11 +337,14 @@ def merge_allof(node: Any, max_depth: int = 32) -> Any: # outrank anything the members declare. for name, subschema in (siblings.get("properties") or {}).items(): properties[name] = subschema - for name in siblings.get("required") or []: + for name in _required_names(siblings): if name not in required: required.append(name) - merged: dict[str, Any] = {**siblings, "type": "object"} + merged: dict[str, Any] = { + **{k: v for k, v in siblings.items() if k != "required"}, + "type": "object", + } if properties: merged["properties"] = properties if required: @@ -694,6 +710,14 @@ def _strip_placeholders(segment: str) -> str: return out.strip(".") +def _required_names(schema: dict[str, Any]) -> list[str]: + """Return a schema's ``required`` property names, ignoring a malformed value.""" + required = schema.get("required") + if not isinstance(required, list): + return [] + return [name for name in required if isinstance(name, str)] + + def detect_api_prefix(spec: dict[str, Any]) -> str: """Compute the longest slash-segmented prefix shared by every path.""" paths = list(spec.get("paths", {}).keys()) @@ -776,10 +800,12 @@ def build_reference( router_map = build_router_map(spec, api_prefix=api_prefix) paths_out: dict[str, dict[str, Any]] = {} + from_get: set[str] = set() routers_out: dict[str, dict[str, Any]] = {} for url, methods in spec.get("paths", {}).items(): - op = methods.get("get") or methods.get("post") - if not op: + is_get = isinstance(methods.get("get"), dict) + op = methods.get("get") if is_get else methods.get("post") + if not is_get and not op: continue parts = [p for p in url.strip("/").split("/") if p] if parts[: len(prefix_parts)] == prefix_parts: @@ -791,7 +817,12 @@ def build_reference( ] cli_path = "/" + "/".join(non_template) op_desc = (op.get("description") or op.get("summary") or "").strip() - if cli_path not in paths_out or not paths_out[cli_path].get("description"): + if is_get and cli_path not in from_get: + paths_out[cli_path] = {"description": op_desc} + from_get.add(cli_path) + elif (is_get or cli_path not in from_get) and ( + cli_path not in paths_out or not paths_out[cli_path].get("description") + ): paths_out[cli_path] = {"description": op_desc} tags = op.get("tags") or [] tag_desc = tag_descriptions.get(tags[0]) if tags else "" @@ -926,6 +957,7 @@ def _bundle_external_refs( *, timeout: float, headers: dict[str, str], + normalize: bool = True, ) -> dict[str, Any]: """Inline same-origin external refs while preserving root-local refs.""" max_documents = 512 @@ -974,6 +1006,7 @@ def _bundle_external_refs( content_type=content_type, ), url, + normalize=normalize, ) documents[url] = parsed return parsed @@ -1102,8 +1135,13 @@ def fetch_openapi( path: str | None = None, headers: dict[str, str] | None = None, query_params: dict[str, str] | None = None, + normalize: bool = True, ) -> dict[str, Any]: - """Fetch the OpenAPI spec at ``base_url`` and return the parsed dict.""" + """Fetch the OpenAPI spec at ``base_url`` and return the parsed dict. + + ``normalize=False`` returns the document as written, without rewriting + OpenAPI 3.1 ``type`` arrays (see ``expand_type_arrays``). + """ explicit_path = path is not None full_url = ( path @@ -1130,12 +1168,14 @@ def fetch_openapi( content_type=response.headers.get("content-type", ""), ), full_url, + normalize=normalize, ) return _bundle_external_refs( parsed, str(getattr(response, "url", full_url)), timeout=timeout, headers=merged_headers, + normalize=normalize, ) except ValueError as exc: parse_error = exc @@ -1155,16 +1195,19 @@ def fetch_openapi( embedded = _extract_embedded_spec(landing.text) if embedded is not None: return _bundle_external_refs( - _ensure_openapi_dict(embedded, landing_url), + _ensure_openapi_dict(embedded, landing_url, normalize=normalize), str(getattr(landing, "url", landing_url)), timeout=timeout, headers=merged_headers, + normalize=normalize, ) _raise_fetch_failure(response, parse_error, full_url) -def _ensure_openapi_dict(parsed: Any, source_url: str) -> dict[str, Any]: +def _ensure_openapi_dict( + parsed: Any, source_url: str, *, normalize: bool = True +) -> dict[str, Any]: """Reject parsed bodies that aren't a JSON object (and thus can't be an OpenAPI doc).""" if not isinstance(parsed, dict): raise ValueError( @@ -1173,7 +1216,7 @@ def _ensure_openapi_dict(parsed: Any, source_url: str) -> dict[str, Any]: "Pass --openapi-path to point at the real spec endpoint " "(e.g. /swagger/v1/swagger.json)." ) - return expand_type_arrays(parsed) + return expand_type_arrays(parsed) if normalize else parsed def expand_type_arrays(node: Any) -> Any: diff --git a/cli/openbb_cli/dispatchers/overlay.py b/cli/openbb_cli/dispatchers/overlay.py new file mode 100644 index 00000000000..c341c519ef4 --- /dev/null +++ b/cli/openbb_cli/dispatchers/overlay.py @@ -0,0 +1,268 @@ +"""Apply OpenAPI Overlay documents to an OpenAPI description before spec build. + +Implements the action model of the OpenAPI Overlay Specification 1.0 +(https://spec.openapis.org/overlay/v1.0.0): each action selects nodes with a +JSONPath ``target`` and either merges an ``update`` into them or removes them. + +Only the JSONPath subset that names nodes directly is supported: ``$``, +``.name``, ``['name']`` / ``["name"]``, ``[index]``, and the ``*`` / ``[*]`` +wildcards. Filters, slices, unions, and recursive descent (``..``) are rejected. +""" + +from __future__ import annotations + +import copy +import datetime +import json +import re +from pathlib import Path +from typing import Any + +_INDEX_RE = re.compile(r"\[(-?[0-9]+)\]") +_INTEGER_RE = re.compile(r"-?[0-9]+") + +Step = str | int | None + + +def parse_target(target: str) -> list[Step]: + """Split a JSONPath expression into lookup steps. + + Parameters + ---------- + target : str + JSONPath expression starting with ``$``. + + Returns + ------- + list[str | int | None] + One step per segment: a key, a list index, or ``None`` for a wildcard. + + Raises + ------ + ValueError + When the expression is malformed or uses unsupported syntax. + """ + if not target.startswith("$"): + raise ValueError(f"JSONPath target must start with '$': {target!r}") + steps: list[Step] = [] + i, n = 1, len(target) + while i < n: + if target.startswith("..", i): + raise ValueError(f"recursive descent '..' is not supported: {target!r}") + if target[i] == ".": + j = i + 1 + while j < n and target[j] not in ".[": + j += 1 + name = target[i + 1 : j] + if not name: + raise ValueError(f"empty segment in JSONPath target: {target!r}") + steps.append(None if name == "*" else name) + i = j + elif target.startswith("[*]", i): + steps.append(None) + i += 3 + elif target[i : i + 2] in ("['", '["'): + quote = target[i + 1] + j = i + 2 + chars: list[str] = [] + while j < n and target[j] != quote: + if target[j] == "\\" and j + 1 < n: + j += 1 + chars.append(target[j]) + j += 1 + if not target.startswith(quote + "]", j): + raise ValueError(f"unterminated quoted segment: {target!r}") + steps.append("".join(chars)) + i = j + 2 + elif match := _INDEX_RE.match(target, i): + steps.append(int(match.group(1))) + i = match.end() + else: + raise ValueError( + f"unsupported JSONPath syntax at position {i}: {target!r} " + "(only $, .name, ['name'], [index], and * are supported)" + ) + return steps + + +def _dict_key(node: dict[Any, Any], step: str | int) -> Any: + """Find the key ``step`` names in ``node``, matching ``"200"`` and ``200`` alike.""" + candidates: list[Any] = [step, str(step)] + if isinstance(step, str) and _INTEGER_RE.fullmatch(step): + candidates.append(int(step)) + for key in candidates: + if key in node: + return key + return None + + +def select(doc: Any, steps: list[Step]) -> list[tuple[Any, Any, Any]]: + """Return ``(parent, key, node)`` for every node the steps select. + + Parameters + ---------- + doc : Any + The document to search. + steps : list[str | int | None] + Output of ``parse_target``. + + Returns + ------- + list[tuple[Any, Any, Any]] + Matches in document order; ``parent`` and ``key`` are ``None`` for the root. + """ + current: list[tuple[Any, Any, Any]] = [(None, None, doc)] + for step in steps: + selected: list[tuple[Any, Any, Any]] = [] + for _, _, node in current: + if step is None: + if isinstance(node, dict): + selected.extend((node, k, v) for k, v in node.items()) + elif isinstance(node, list): + selected.extend((node, k, v) for k, v in enumerate(node)) + elif isinstance(node, dict): + key = _dict_key(node, step) + if key is not None: + selected.append((node, key, node[key])) + elif ( + isinstance(node, list) + and isinstance(step, int) + and -len(node) <= step < len(node) + ): + selected.append((node, step % len(node), node[step])) + current = selected + return current + + +def _merge(target: dict[Any, Any], update: dict[Any, Any]) -> None: + """Recursively merge ``update`` into ``target``; non-object values replace. + + An update key matches the target key it names, so ``200`` merges into an + existing ``"200"`` (see ``_dict_key``). + """ + for key, value in update.items(): + found = _dict_key(target, key) if isinstance(key, (str, int)) else None + slot = key if found is None else found + if isinstance(value, dict) and isinstance(target.get(slot), dict): + _merge(target[slot], value) + else: + target[slot] = copy.deepcopy(value) + + +def _json_key(key: Any) -> str: + """Return a YAML mapping key as the string JSON would use.""" + if isinstance(key, bool) or key is None: + return json.dumps(key) + if isinstance(key, datetime.date): + return key.isoformat() + return str(key) + + +def _json_compatible(node: Any) -> Any: + """Give YAML-only values their JSON form: string keys, ISO date text.""" + if isinstance(node, dict): + return {_json_key(k): _json_compatible(v) for k, v in node.items()} + if isinstance(node, list): + return [_json_compatible(v) for v in node] + if isinstance(node, datetime.date): + return node.isoformat() + return node + + +def load_overlay(path: str | Path) -> dict[str, Any]: + """Read and validate an Overlay document from a YAML or JSON file. + + Mapping keys are read as strings and unquoted YAML dates as ISO text, as + JSON would give them. + + Parameters + ---------- + path : str or Path + Location of the overlay file. + + Returns + ------- + dict[str, Any] + The parsed overlay document. + + Raises + ------ + ValueError + When the file is not valid YAML or JSON, or not an Overlay document. + """ + import yaml + + text = Path(path).read_text(encoding="utf-8-sig") + try: + doc = json.loads(text) + except ValueError: + try: + doc = yaml.safe_load(text) + except yaml.YAMLError as exc: + raise ValueError(f"not valid YAML or JSON: {exc}") from exc + doc = _json_compatible(doc) + if not isinstance(doc, dict) or "overlay" not in doc: + raise ValueError("not an OpenAPI Overlay document (missing 'overlay' field)") + if not isinstance(doc.get("actions"), list): + raise ValueError("overlay 'actions' must be a list") + return doc + + +def apply_overlay( + openapi: dict[str, Any], overlay: dict[str, Any] +) -> tuple[dict[str, Any], list[str]]: + """Apply every action of ``overlay`` to a copy of ``openapi``, in order. + + An ``update`` is merged into each selected object (nested objects merge, + other values replace) or appended to each selected array. ``remove: true`` + deletes each selected node from its parent. The document is read as JSON + would give it (string keys, ISO date text), so YAML response codes and an + overlay's keys agree. + + Parameters + ---------- + openapi : dict + The OpenAPI document; it is not modified. + overlay : dict + A validated Overlay document (see ``load_overlay``). + + Returns + ------- + tuple[dict, list[str]] + The updated document and the targets that selected nothing. + + Raises + ------ + ValueError + When an action is malformed or cannot apply to what it selects. + """ + doc = _json_compatible(openapi) + unmatched: list[str] = [] + for index, action in enumerate(overlay.get("actions") or []): + target = action.get("target") if isinstance(action, dict) else None + if not isinstance(target, str): + raise ValueError(f"actions[{index}] needs a string 'target'") + matches = select(doc, parse_target(target)) + if not matches: + unmatched.append(target) + continue + if action.get("remove") is True: + for parent, key, _ in reversed(matches): + if parent is None: + raise ValueError(f"actions[{index}] cannot remove the root") + del parent[key] + continue + if "update" not in action: + continue + update = _json_compatible(action["update"]) + for _, _, node in matches: + if isinstance(node, list): + node.append(copy.deepcopy(update)) + elif isinstance(node, dict) and isinstance(update, dict): + _merge(node, update) + else: + raise ValueError( + f"actions[{index}] update must target objects or arrays, " + f"and an object target needs an object update: {target!r}" + ) + return doc, unmatched diff --git a/cli/openbb_cli/dispatchers/runtime.py b/cli/openbb_cli/dispatchers/runtime.py index 08d0adaddf7..bdeb4134f83 100644 --- a/cli/openbb_cli/dispatchers/runtime.py +++ b/cli/openbb_cli/dispatchers/runtime.py @@ -415,6 +415,31 @@ def build_parser() -> argparse.ArgumentParser: "need this. JSON or YAML accepted." ), ) + parser.add_argument( + "--api-prefix", + metavar="PREFIX", + default=None, + help=( + "URL path prefix stripped from each path when --generate-spec names " + "commands, e.g. ``--api-prefix /api/v3`` turns ``/api/v3/klines`` " + "into ``klines``. Paths outside the prefix keep their full name; " + "request URLs are unaffected. A path the prefix strips to nothing " + "is skipped, and listed in a warning. Default: the longest prefix " + "the paths share, leaving out each path's last segment." + ), + ) + parser.add_argument( + "--overlay", + metavar="PATH", + action="append", + default=None, + help=( + "OpenAPI Overlay 1.0 document (YAML or JSON) applied to the fetched " + "OpenAPI description before --generate-spec builds the spec. Use it " + "to correct upstream schema errors without editing the generated " + "code. Repeatable; overlays apply in order." + ), + ) parser.add_argument( "--socrata-story", metavar="URL_OR_PATH", diff --git a/cli/openbb_cli/dispatchers/spec.py b/cli/openbb_cli/dispatchers/spec.py index fe79aaf66b3..7b8cb5fe395 100644 --- a/cli/openbb_cli/dispatchers/spec.py +++ b/cli/openbb_cli/dispatchers/spec.py @@ -26,6 +26,7 @@ from openbb_cli.dispatchers.openapi_schema import ( extract_request_body_schema, extract_response_schema, extract_response_schemas, + merge_allof, operation_parameters, param_provider_membership, parse_json_arg, @@ -131,6 +132,36 @@ def _list_style(param: dict[str, Any], location: str) -> str: return "multi" if explode and style in (None, "form") else "csv" +def _json_encoded_array( + param: dict[str, Any], schema: dict[str, Any] +) -> dict[str, Any] | None: + """Return the array schema of a parameter whose value is a JSON-encoded array. + + OpenAPI declares one with ``content: {application/json: {schema: ...}}`` on + the Parameter Object, or, in JSON Schema 2019-09+ (OpenAPI 3.1), with + ``contentMediaType: application/json`` plus ``contentSchema`` on a string. + """ + candidates: list[Any] = [] + content = param.get("content") + if isinstance(content, dict): + candidates.extend( + media.get("schema") + for media_type, media in content.items() + if "json" in str(media_type).lower() and isinstance(media, dict) + ) + if "json" in str(schema.get("contentMediaType") or "").lower(): + candidates.append(schema.get("contentSchema")) + return next( + ( + candidate + for candidate in candidates + if isinstance(candidate, dict) + and (candidate.get("type") == "array" or "items" in candidate) + ), + None, + ) + + def _normalize_parameter( param: dict[str, Any], providers_set: set[str] | None = None ) -> dict[str, Any] | None: @@ -142,7 +173,8 @@ def _normalize_parameter( location = param.get("in", "query") schema = param.get("schema", {}) or {} json_arg = bool(param.get("_json_arg")) - py_type, enum_choices, is_list = _resolve_schema(schema) + json_array = _json_encoded_array(param, schema) if location == "query" else None + py_type, enum_choices, is_list = _resolve_schema(json_array or schema) described = None if not is_list and location in ("query", "header", "cookie"): described = _described_delimiter( @@ -159,7 +191,11 @@ def _normalize_parameter( required = bool(param.get("required")) or location == "path" default = schema.get("default") lower_choices = {str(c).lower() for c in choices} - if "json" in lower_choices and lower_choices & {"xml", "csv"}: + if ( + "json" in lower_choices + and lower_choices & {"xml", "csv"} + and not param.get("_no_default") + ): default = "json" if default is not None: required = False @@ -181,6 +217,15 @@ def _normalize_parameter( break if example is None: example = schema.get("example") + if example is None and isinstance(param.get("content"), dict): + example = next( + ( + media["example"] + for media in param["content"].values() + if isinstance(media, dict) and media.get("example") is not None + ), + None, + ) type_name = _TYPE_TO_NAME.get(py_type, "string") if ( @@ -190,9 +235,12 @@ def _normalize_parameter( ): type_name = "integer" - list_style = ( - {"list_style": described or _list_style(param, location)} if is_list else {} - ) + if json_array is not None: + list_style = {"list_style": "json"} + elif is_list: + list_style = {"list_style": described or _list_style(param, location)} + else: + list_style = {} return { "name": name, "in": location, @@ -248,6 +296,168 @@ def _security_parameters( return out +_GROUP_ALTERNATIVE_KEYS = frozenset({"required", "description", "title"}) + + +def _required_groups(schema: dict[str, Any], *, required: bool) -> list[dict[str, Any]]: + """Read the ``oneOf`` / ``anyOf`` required-property groups of an object schema. + + Each alternative must do nothing but list required properties. A + combinator with any other kind of alternative is skipped: enforcing part + of it would reject calls the API accepts. + + Parameters + ---------- + schema : dict + The object schema of a form-exploded query parameter. + required : bool + Whether the parameter itself is required. An optional one is only + checked when at least one of its properties is passed. + + Returns + ------- + list[dict] + ``{"combinator", "alternatives", "members", "required"}`` per group; + ``alternatives`` lists the property names each alternative requires and + ``members`` lists every property of the object. + """ + properties = schema.get("properties") or {} + groups: list[dict[str, Any]] = [] + for combinator in ("oneOf", "anyOf"): + raw_alternatives = schema.get(combinator) + if not isinstance(raw_alternatives, list) or not raw_alternatives: + continue + alternatives: list[list[str]] = [] + for alternative in raw_alternatives: + names = ( + alternative.get("required") if isinstance(alternative, dict) else None + ) + if ( + not isinstance(names, list) + or not names + or set(alternative) - _GROUP_ALTERNATIVE_KEYS + or any(not isinstance(n, str) or n not in properties for n in names) + ): + alternatives = [] + break + alternatives.append(list(names)) + if alternatives: + groups.append( + { + "combinator": combinator, + "alternatives": alternatives, + "members": list(properties), + "required": required, + } + ) + return groups + + +def _explode_object_parameter( + param: dict[str, Any], +) -> tuple[list[dict[str, Any]], list[dict[str, Any]]] | None: + """Split a form-exploded object query parameter into one parameter per property. + + ``style: form`` with ``explode: true`` (the query default) sends each + property of an object value as its own ``name=value`` pair, so each + property is a query parameter in its own right. + + Parameters + ---------- + param : dict + A dereferenced OpenAPI Parameter Object. + + An optional object's own ``required`` list becomes an ``anyOf`` group that + only applies when one of its properties is passed. Property ``default`` + values are dropped where a group must see whether the caller passed a + value: from alternatives of a required object, and from every member of an + optional object with groups. The server applies its own default to an + omitted parameter. + + Returns + ------- + tuple[list[dict], list[dict]] or None + The per-property Parameter Objects and the object's required groups + (see ``_required_groups``), or ``None`` when ``param`` is not a + form-exploded object query parameter with declared properties. + """ + if param.get("in", "query") != "query" or param.get("style", "form") != "form": + return None + if param.get("explode", True) is False: + return None + schema = merge_allof(param.get("schema")) + if not isinstance(schema, dict): + return None + properties = schema.get("properties") + schema_type = schema.get("type", "object") + schema_types = schema_type if isinstance(schema_type, list) else [schema_type] + if ( + not isinstance(properties, dict) + or not properties + or "object" not in schema_types + ): + return None + param_required = bool(param.get("required")) + declared_required = schema.get("required") + object_required = [ + n + for n in properties + if isinstance(declared_required, list) and n in declared_required + ] + groups = _required_groups(schema, required=param_required) + if object_required and not param_required: + groups.append( + { + "combinator": "anyOf", + "alternatives": [object_required], + "members": list(properties), + "required": False, + } + ) + if param_required: + defaultless = {n for g in groups for alt in g["alternatives"] for n in alt} + else: + defaultless = set(properties) if groups else set() + examples = _object_example(param, schema) + exploded: list[dict[str, Any]] = [] + for name, prop_schema in properties.items(): + prop = prop_schema if isinstance(prop_schema, dict) else {} + if name in defaultless: + prop = {k: v for k, v in prop.items() if k != "default"} + entry: dict[str, Any] = { + "name": name, + "in": "query", + "required": param_required and name in object_required, + "schema": prop, + } + if name in defaultless: + entry["_no_default"] = True + if name in examples: + entry["example"] = examples[name] + exploded.append(entry) + return exploded, groups + + +def _object_example(param: dict[str, Any], schema: dict[str, Any]) -> dict[str, Any]: + """Return the first object-valued example a parameter or its schema gives. + + Looks at ``param.example``, the values of ``param.examples``, then + ``schema.example`` and the OpenAPI 3.1 ``schema.examples`` list. + """ + candidates: list[Any] = [param.get("example")] + examples_map = param.get("examples") + if isinstance(examples_map, dict): + candidates.extend( + entry.get("value") + for entry in examples_map.values() + if isinstance(entry, dict) + ) + candidates.append(schema.get("example")) + if isinstance(schema.get("examples"), list): + candidates.extend(schema["examples"]) + return next((c for c in candidates if isinstance(c, dict)), {}) + + def _build_operation_entry( spec: dict[str, Any], url: str, @@ -260,11 +470,37 @@ def _build_operation_entry( providers = _operation_providers(op) providers_set = set(providers) if providers else None params: list[dict[str, Any]] = [] - for resolved in operation_parameters(spec, path_item or {}, op): - normalized = _normalize_parameter(resolved, providers_set) - if normalized is not None: - params.append(normalized) + required_groups: list[dict[str, Any]] = [] + resolved_params = operation_parameters(spec, path_item or {}, op) + exploded_params = [_explode_object_parameter(p) for p in resolved_params] + taken = { + p.get("name") + for p, exploded in zip(resolved_params, exploded_params, strict=True) + if exploded is None + } + for resolved, exploded in zip(resolved_params, exploded_params, strict=True): + if exploded is None: + candidates = [resolved] + else: + properties, groups = exploded + candidates = [p for p in properties if p["name"] not in taken] + skipped = {p["name"] for p in properties} - {p["name"] for p in candidates} + taken.update(p["name"] for p in candidates) + for group in groups: + if skipped & {n for alt in group["alternatives"] for n in alt}: + continue + members = [m for m in group["members"] if m not in skipped] + required_groups.append({**group, "members": members}) + for candidate in candidates: + normalized = _normalize_parameter(candidate, providers_set) + if normalized is not None: + params.append(normalized) declared = {p["name"] for p in params} + required_groups = [ + group + for group in required_groups + if all(name in declared for alt in group["alternatives"] for name in alt) + ] # A required header/cookie the path item declares for every operation (a # tenant id, a session cookie) isn't a per-call argument — it routes through # credentials.classify_parameter, same as an apiKey security scheme. @@ -286,6 +522,7 @@ def _build_operation_entry( "method": method, "description": (op.get("description") or op.get("summary") or "").strip(), "parameters": params, + **({"required_groups": required_groups} if required_groups else {}), "providers": providers, "request_body_schema": extract_request_body_schema(spec, op), "response_schema": extract_response_schema(spec, op, accept), @@ -301,15 +538,26 @@ def _merge_overload_entries(entries: list[dict[str, Any]]) -> dict[str, Any]: the dispatcher picks the longest URL template whose placeholders are satisfied at call time. Query-/body- params are unioned by name; ``required`` holds only when the param is required in every variant where it appears. + Required groups are unioned the same way: one that is missing from, or + optional in, any variant is only checked when its members are passed. + ``template_response_schemas`` keeps the response schema of each variant + whose schema differs from the shortest URL's. ``template_query_params`` + records the query parameters each variant declares, so a call can drop the ones its URL does not take and a variant + can take another variant's placeholder as a query parameter + (``/sigmets?date=`` beside ``/sigmets/{atsu}/{date}``). """ entries = sorted(entries, key=lambda e: -_count_path_placeholders(e["url_path"])) base = entries[-1] by_name: dict[str, dict[str, Any]] = {} seen_in_count: dict[str, int] = {} + required_everywhere: dict[str, bool] = {} for entry in entries: for p in entry["parameters"]: name = p["name"] seen_in_count[name] = seen_in_count.get(name, 0) + 1 + required_everywhere[name] = required_everywhere.get(name, True) and bool( + p.get("required") + ) merged = by_name.setdefault(name, dict(p)) if not merged.get("help") and p.get("help"): merged["help"] = p["help"] @@ -322,9 +570,35 @@ def _merge_overload_entries(entries: list[dict[str, Any]]) -> dict[str, Any]: total_entries = len(entries) merged_params: list[dict[str, Any]] = [] for name, merged in by_name.items(): - if seen_in_count[name] < total_entries: + if seen_in_count[name] < total_entries or not required_everywhere[name]: merged["required"] = False merged_params.append(merged) + groups_by_key: dict[str, dict[str, Any]] = {} + group_counts: dict[str, int] = {} + for entry in entries: + for group in entry.get("required_groups") or []: + key = json.dumps( + {k: v for k, v in group.items() if k != "required"}, sort_keys=True + ) + merged_group = groups_by_key.setdefault(key, dict(group)) + merged_group["required"] = merged_group["required"] and group["required"] + group_counts[key] = group_counts.get(key, 0) + 1 + required_groups: list[dict[str, Any]] = [] + for key, merged_group in groups_by_key.items(): + if group_counts[key] < total_entries: + merged_group["required"] = False + required_groups.append(merged_group) + template_response_schemas = { + entry["url_path"]: entry.get("response_schema") + for entry in entries + if entry.get("response_schema") != base.get("response_schema") + } + template_query_params = { + entry["url_path"]: [ + p["name"] for p in entry["parameters"] if p.get("in") == "query" + ] + for entry in entries + } description = next( (entry.get("description") for entry in entries if entry.get("description")), "", @@ -332,12 +606,19 @@ def _merge_overload_entries(entries: list[dict[str, Any]]) -> dict[str, Any]: return { "url_path": base["url_path"], "url_templates": [entry["url_path"] for entry in entries], + "template_query_params": template_query_params, "method": base["method"], "description": description, "parameters": merged_params, + **({"required_groups": required_groups} if required_groups else {}), "providers": base.get("providers", []), "request_body_schema": base.get("request_body_schema"), "response_schema": base.get("response_schema"), + **( + {"template_response_schemas": template_response_schemas} + if template_response_schemas + else {} + ), "response_schemas": base.get("response_schemas"), } @@ -347,6 +628,26 @@ def _count_path_placeholders(url: str) -> int: return url.count("{") +_BODY_DOC_KEYS = frozenset({"description", "example", "examples", "title"}) + + +def _body_shape(schema: Any) -> Any: + """Return a request body schema without docs and with ``required`` sorted.""" + if isinstance(schema, list): + return [_body_shape(v) for v in schema] + if not isinstance(schema, dict): + return schema + out: dict[str, Any] = {} + for key, value in schema.items(): + if key in ("properties", "patternProperties") and isinstance(value, dict): + out[key] = {name: _body_shape(sub) for name, sub in value.items()} + elif key == "required" and isinstance(value, list): + out[key] = sorted(map(str, value)) + elif key not in _BODY_DOC_KEYS: + out[key] = _body_shape(value) + return out + + def build_command_spec( spec: dict[str, Any], *, api_prefix: str = "/api/v1", accept: str | None = None ) -> dict[str, dict[str, Any]]: @@ -355,28 +656,76 @@ def build_command_spec( URLs that strip to the same dotted command (e.g. ``/x/{a}`` and ``/x/{a}/{b}``) are merged into a single command entry whose ``url_templates`` lists every variant. The dispatcher picks the longest - fully-satisfied template at call time. + fully-satisfied template at call time. GET operations merge with each + other; POST operations merge only when they take the same request body + (descriptions, examples and titles aside). + When a name has GET operations, the GET command keeps it and each POST + command becomes ``_post``; further POST commands of that name, or a + ``_post`` another URL already takes, get a number + (``_post2``). """ groups: dict[str, list[dict[str, Any]]] = {} for url, methods in spec.get("paths", {}).items(): - if "get" in methods: - method, op = "get", methods["get"] - elif "post" in methods: - method, op = "post", methods["post"] - else: - continue base_cmd = url_to_command(url, api_prefix=api_prefix) if not base_cmd: continue - groups.setdefault(base_cmd, []).append( - _build_operation_entry(spec, url, method, op, methods, accept) - ) - out: dict[str, dict[str, Any]] = {} + for method in ("get", "post"): + if method in methods: + groups.setdefault(base_cmd, []).append( + _build_operation_entry( + spec, url, method, methods[method], methods, accept + ) + ) + taken = set(groups) + split: dict[str, list[dict[str, Any]]] = {} for cmd, entries in groups.items(): + buckets: dict[tuple[str, str], list[dict[str, Any]]] = {} + for entry in entries: + body = ( + "" + if entry["method"] == "get" + else json.dumps( + _body_shape(entry.get("request_body_schema")), + sort_keys=True, + default=str, + ) + ) + buckets.setdefault((entry["method"], body), []).append(entry) + keeps_name = next( + (key for key in buckets if key[0] == "get"), next(iter(buckets)) + ) + for key, bucket in buckets.items(): + if key == keeps_name: + name = cmd + else: + name, number = f"{cmd}_{key[0]}", 2 + while name in taken: + name, number = f"{cmd}_{key[0]}{number}", number + 1 + taken.add(name) + split[name] = bucket + out: dict[str, dict[str, Any]] = {} + for cmd, entries in split.items(): out[cmd] = entries[0] if len(entries) == 1 else _merge_overload_entries(entries) return out +def unnamed_paths(openapi: dict[str, Any], *, api_prefix: str) -> list[str]: + """Return the GET/POST paths that stripping ``api_prefix`` leaves without a name. + + A path equal to the prefix, or the prefix plus only placeholders, strips + to an empty name, so no command is built for it. Paths that have no name + even unstripped (``/``, ``/{id}``) are not listed. + """ + return [ + url + for url, methods in (openapi.get("paths") or {}).items() + if isinstance(methods, dict) + and ("get" in methods or "post" in methods) + and not url_to_command(url, api_prefix=api_prefix) + and url_to_command(url, api_prefix="") + ] + + def _resolve_base_url(openapi: dict[str, Any], user_base_url: str) -> str: """Honor the OpenAPI ``servers[0].url`` when it adds a path component.""" user_clean = user_base_url.rstrip("/") @@ -421,10 +770,14 @@ def build_spec_document( from each command so they are not surfaced as arguments. Credential headers (``API-Key``, ``Authorization``, ...) are left alone: the credential detection maps them to the generated ``Credentials`` objects. + + ``api_prefix`` overrides the prefix stripped from paths when naming + commands; paths outside it keep their full name. The recorded + ``api_prefix`` stays the prefix every path shares, so URLs resolve the + same either way. """ - effective_prefix = ( - api_prefix if api_prefix is not None else detect_api_prefix(openapi) - ) + detected_prefix = detect_api_prefix(openapi) + effective_prefix = api_prefix if api_prefix is not None else detected_prefix accept = next( (v for k, v in (headers or {}).items() if k.lower() == "accept"), None ) @@ -439,11 +792,24 @@ def build_spec_document( "source_url": source_url or "", "api_version": str(openapi.get("openapi") or openapi.get("swagger") or ""), "base_url": _resolve_base_url(openapi, base_url), - "api_prefix": (("/" + effective_prefix.strip("/")) if effective_prefix else ""), + "api_prefix": (("/" + detected_prefix.strip("/")) if detected_prefix else ""), "commands": commands, "routers": build_router_map(openapi, api_prefix=effective_prefix), "reference": build_reference(openapi, api_prefix=effective_prefix), } + for name, command in commands.items(): + path = "/" + name.replace(".", "/") + if name not in doc["routers"]: + doc["routers"][name] = "command" + elif ( + command.get("method") == "get" + or f"{name}_post" not in commands + or path not in doc["reference"]["paths"] + ): + continue + doc["reference"].setdefault("paths", {})[path] = { + "description": command.get("description") or "" + } if headers: doc["headers"] = dict(headers) return doc @@ -604,12 +970,19 @@ def parser_from_command_spec( ) required_group = parser.add_argument_group("required arguments") optional_group = parser.add_argument_group("optional arguments") + group_members = { + name + for group in cmd_spec.get("required_groups") or [] + for name in group.get("members") or [] + } for p in command_parameters(cmd_spec): if not _param_visible_for_provider(p, selected_provider): continue target = required_group if p.get("required") else optional_group try: - _add_normalized_parameter(target, p) + _add_normalized_parameter( + target, p, unset_when_omitted=p.get("name") in group_members + ) except argparse.ArgumentError: continue return parser @@ -626,9 +999,16 @@ def _param_visible_for_provider( def _add_normalized_parameter( - parser: argparse._ActionsContainer, p: dict[str, Any] + parser: argparse._ActionsContainer, + p: dict[str, Any], + *, + unset_when_omitted: bool = False, ) -> None: - """Translate one normalized parameter dict into a parser argument.""" + """Translate one normalized parameter dict into a parser argument. + + ``unset_when_omitted`` leaves an omitted boolean flag without a value + instead of ``False``, so a required group can tell it was not passed. + """ flag = f"--{p['name']}" py_type = _NAME_TO_TYPE.get(p.get("type", "string"), str) kwargs: dict[str, Any] = {"dest": p["name"], "help": _escape_help(p.get("help"))} @@ -641,9 +1021,14 @@ def _add_normalized_parameter( return if py_type is bool: + default = p.get("default") kwargs.update( action=argparse.BooleanOptionalAction, - default=bool(p.get("default") or False), + default=( + None + if default is None and unset_when_omitted + else bool(default or False) + ), ) parser.add_argument(flag, **kwargs) return @@ -659,7 +1044,7 @@ def _add_normalized_parameter( kwargs["type"] = py_type if p.get("default") is not None: kwargs["default"] = p["default"] - if p.get("choices"): + if p.get("choices") and p.get("list_style") != "json": kwargs["choices"] = list(p["choices"]) if p.get("is_list"): kwargs["nargs"] = "+" diff --git a/cli/tests/test_cli.py b/cli/tests/test_cli.py index 1c420cd0103..5b67ec8dab6 100644 --- a/cli/tests/test_cli.py +++ b/cli/tests/test_cli.py @@ -985,6 +985,202 @@ def test_generate_spec_errors_when_zero_commands(tmp_path, capsys): assert not (tmp_path / "x.spec").exists() +def test_main_generate_spec_passes_api_prefix_and_overlays(): + with patch("openbb_cli.cli._generate_spec", return_value=0) as gen: + rc = cli.main( + [ + "--server", + "http://x", + "--generate-spec", + "--api-prefix", + "/api/v3", + "--overlay", + "a.yaml", + "--overlay", + "b.yaml", + ] + ) + assert rc == 0 + _, kwargs = gen.call_args + assert kwargs["api_prefix"] == "/api/v3" + assert kwargs["overlays"] == ["a.yaml", "b.yaml"] + + +_PREFIXED_OPENAPI = { + "openapi": "3.0.2", + "paths": { + "/api/v3/aggTrades": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": {"$ref": "#/components/schemas/aggTrade"}, + } + } + } + } + } + } + }, + "/sapi/v1/system/status": {"get": {"responses": {}}}, + }, + "components": { + "schemas": { + "aggTrade": { + "type": "object", + "properties": {"T": {"type": "boolean"}}, + } + } + }, +} + + +def test_generate_spec_applies_overlay_and_api_prefix(tmp_path): + from openbb_cli.dispatchers.spec import load_spec + + overlay = tmp_path / "fix.overlay.yaml" + overlay.write_text( + "overlay: 1.0.0\n" + "info: {title: fix, version: '1'}\n" + "actions:\n" + " - target: $.components.schemas.aggTrade.properties.T\n" + " update: {type: integer}\n" + ) + out = tmp_path / "x.spec" + with patch( + "openbb_cli.dispatchers.openapi_schema.fetch_openapi", + return_value=_PREFIXED_OPENAPI, + ): + rc = cli._generate_spec( + "http://localhost:8000", + str(out), + "/openapi.yaml", + api_prefix="/api/v3", + overlays=[str(overlay)], + ) + assert rc == 0 + spec = load_spec(out) + assert set(spec["commands"]) == {"aggTrades", "sapi.v1.system.status"} + row = spec["commands"]["aggTrades"]["response_schema"]["items"] + assert row["properties"]["T"]["type"] == "integer" + + +def test_generate_spec_warns_on_overlay_target_that_matches_nothing(tmp_path, capsys): + overlay = tmp_path / "fix.overlay.yaml" + overlay.write_text( + "overlay: 1.0.0\nactions:\n - target: $.components.nope\n update: {}\n" + ) + with patch( + "openbb_cli.dispatchers.openapi_schema.fetch_openapi", + return_value=_PREFIXED_OPENAPI, + ): + rc = cli._generate_spec( + "http://localhost:8000", + str(tmp_path / "x.spec"), + "/openapi.yaml", + overlays=[str(overlay)], + ) + assert rc == 0 + assert "target matched nothing: $.components.nope" in capsys.readouterr().err + + +def test_generate_spec_rejects_invalid_overlay(tmp_path, capsys): + overlay = tmp_path / "not-an-overlay.yaml" + overlay.write_text("openapi: 3.0.0\n") + with patch( + "openbb_cli.dispatchers.openapi_schema.fetch_openapi", + return_value=_PREFIXED_OPENAPI, + ): + rc = cli._generate_spec( + "http://localhost:8000", + str(tmp_path / "x.spec"), + "/openapi.yaml", + overlays=[str(overlay), str(tmp_path / "missing.yaml")], + ) + assert rc == 2 + assert "missing 'overlay' field" in capsys.readouterr().err + assert not (tmp_path / "x.spec").exists() + + +def test_generate_spec_applies_overlay_before_type_arrays_are_rewritten(tmp_path): + from openbb_cli.dispatchers.spec import load_spec + + openapi = { + "openapi": "3.1.0", + "paths": { + "/x": { + "get": { + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": {"type": ["string", "null"]}, + } + ], + "responses": {}, + } + } + }, + } + overlay = tmp_path / "fix.overlay.yaml" + overlay.write_text( + "overlay: 1.0.0\n" + "actions:\n" + " - target: $.paths['/x'].get.parameters[0].schema\n" + " update: {type: [integer, 'null']}\n" + ) + out = tmp_path / "x.spec" + with patch( + "openbb_cli.dispatchers.openapi_schema.fetch_openapi", return_value=openapi + ) as fetch: + rc = cli._generate_spec( + "http://localhost:8000", str(out), "/openapi.json", overlays=[str(overlay)] + ) + assert rc == 0 + assert fetch.call_args.kwargs["normalize"] is False + (param,) = load_spec(out)["commands"]["x"]["parameters"] + assert param["type"] == "integer" + + +def test_generate_spec_reports_invalid_overlay_yaml(tmp_path, capsys): + overlay = tmp_path / "bad.yaml" + overlay.write_text("overlay: 1.0.0\nactions: [\n") + with patch( + "openbb_cli.dispatchers.openapi_schema.fetch_openapi", + return_value=_PREFIXED_OPENAPI, + ): + rc = cli._generate_spec( + "http://localhost:8000", + str(tmp_path / "x.spec"), + "/openapi.yaml", + overlays=[str(overlay)], + ) + assert rc == 2 + assert f"--overlay {overlay}: not valid YAML or JSON" in capsys.readouterr().err + + +def test_generate_spec_warns_about_paths_the_api_prefix_leaves_unnamed( + tmp_path, capsys +): + with patch( + "openbb_cli.dispatchers.openapi_schema.fetch_openapi", + return_value=_PREFIXED_OPENAPI, + ): + rc = cli._generate_spec( + "http://localhost:8000", + str(tmp_path / "x.spec"), + "/openapi.yaml", + api_prefix="/api/v3/aggTrades", + ) + assert rc == 0 + err = capsys.readouterr().err + assert "--api-prefix /api/v3/aggTrades: no command name is left for" in err + assert "/api/v3/aggTrades;" in err + + def test_generate_extension_aborts_when_spec_has_zero_commands(tmp_path, capsys): """An empty spec never reaches codegen — no zero-command skeleton package.""" from openbb_cli.dispatchers.spec import SPEC_VERSION, write_spec diff --git a/cli/tests/test_codegen_fetcher_gen.py b/cli/tests/test_codegen_fetcher_gen.py index 3e2139dda44..0c427ac0159 100644 --- a/cli/tests/test_codegen_fetcher_gen.py +++ b/cli/tests/test_codegen_fetcher_gen.py @@ -3,6 +3,9 @@ from __future__ import annotations import ast +import re + +import pytest from openbb_cli.codegen import fetcher_gen as fg @@ -1345,3 +1348,749 @@ def test_oneof_of_wrapper_variants_models_the_rows_inside_each(): ] } assert fg._wrapper_choice_rows(flat) is None + + +_KLINES_RESPONSE = { + "type": "array", + "items": { + "type": "array", + "items": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, + }, +} + + +def test_response_shape_marks_array_of_arrays_as_tuples(): + assert fg._response_shape(_KLINES_RESPONSE) == (None, "tuples") + assert fg._response_shape({"type": "array", "items": {"items": {}}}) == ( + None, + "tuples", + ) + assert fg._response_shape({"type": "array", "items": {"type": "object"}}) == ( + None, + "records", + ) + union_items = {"oneOf": [{"type": "object"}, {"type": "array"}]} + assert fg._response_shape({"type": "array", "items": union_items}) == ( + None, + None, + ) + + +def test_unpack_hint_for_array_of_arrays(): + assert fg._unpack_hint({"response_schema": _KLINES_RESPONSE}) == ', kind="tuples"' + + +def test_data_schema_array_of_arrays_is_one_row_per_inner_array(): + out = fg._data_schema({"response_schema": _KLINES_RESPONSE}) + assert out == { + "type": "object", + "properties": {"value": _KLINES_RESPONSE["items"]}, + "required": ["value"], + } + + +def test_generate_fetcher_module_types_tuple_rows_as_lists(): + spec = fg.FetcherCommandSpec( + name="klines", + cmd_spec={ + "url_path": "/api/v3/klines", + "method": "get", + "parameters": [], + "request_body_schema": None, + "response_schema": _KLINES_RESPONSE, + }, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + assert "value: list[int | str]" in src + assert 'unpack_response(_payload, kind="tuples")' in src + ast.parse(src) + + +_GROUP = { + "combinator": "oneOf", + "alternatives": [["symbol"], ["symbols"]], + "members": ["symbol", "symbols"], + "required": True, +} + + +def _grouped_cmd_spec(groups): + return { + "url_path": "/api/v3/ticker", + "method": "get", + "parameters": [ + {"name": "symbol", "in": "query", "type": "string"}, + {"name": "symbols", "in": "query", "type": "string"}, + ], + "required_groups": groups, + "request_body_schema": None, + "response_schema": {"type": "object", "properties": {"x": {"type": "string"}}}, + } + + +def test_query_params_schema_carries_required_groups(): + schema = fg._query_params_schema(_grouped_cmd_spec([_GROUP]), "prov") + assert schema["x-required-groups"] == [_GROUP] + + +def test_query_params_schema_drops_groups_naming_missing_fields(): + stale = {**_GROUP, "alternatives": [["symbol"], ["gone"]]} + schema = fg._query_params_schema(_grouped_cmd_spec([stale]), "prov") + assert "x-required-groups" not in schema + + +def test_generate_fetcher_module_enforces_required_groups(): + spec = fg.FetcherCommandSpec( + name="ticker", + cmd_spec=_grouped_cmd_spec([_GROUP]), + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + model = _exec_query_params(src, "TickerQueryParams") + model(symbol="BTCUSDT") + with pytest.raises( + ValueError, match=re.escape("Pass exactly one of: symbol | symbols") + ): + model() + + +def _exec_query_params(src: str, class_name: str): + """Exec a generated fetcher module with its package-relative imports stubbed.""" + import re + import sys + import types + + assert re.search(r"^from pydantic import .*\bmodel_validator\b", src, re.M) + utils = types.ModuleType("_generated_utils") + from openbb_cli.dispatchers import _unpack + + utils.__dict__.update(_unpack.__dict__) + sys.modules["_generated_utils"] = utils + try: + namespace: dict = {} + exec( # noqa: S102 + src.replace("from ....utils import", "from _generated_utils import"), + namespace, + ) + return namespace[class_name] + finally: + sys.modules.pop("_generated_utils", None) + + +def test_generate_streaming_fetcher_module_enforces_required_groups(): + cmd_spec = _grouped_cmd_spec([_GROUP]) + cmd_spec["response_schemas"] = {"200": {"text/event-stream": {}}} + spec = fg.FetcherCommandSpec( + name="ticker", + cmd_spec=cmd_spec, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + out = fg.generate_fetcher_module(spec) + assert out.is_streaming + model = _exec_query_params(out.source, "TickerQueryParams") + with pytest.raises(ValueError, match="Pass exactly one of"): + model(symbol="A", symbols="B") + + +def test_generated_fetchers_url_encode_the_query(): + spec = fg.FetcherCommandSpec( + name="klines", + cmd_spec=_grouped_cmd_spec([]), + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + assert "_query_string = encode_query(_query_dict)" in src + assert "get_querystring" not in src + + +def test_json_list_param_is_sent_as_a_json_array(): + cmd_spec = _grouped_cmd_spec([]) + cmd_spec["parameters"][1].update(is_list=True, list_style="json") + spec = fg.FetcherCommandSpec( + name="ticker", + cmd_spec=cmd_spec, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + assert '_query_dict["symbols"] = json_array(_query_dict["symbols"])' in src or ( + "_query_dict['symbols'] = json_array(_query_dict['symbols'])" in src + ) + assert re.search(r"^from \.\.\.\.utils import .*\bjson_array\b", src, re.M) + assert ( + '"multiple_items_allowed": True' in src + or "'multiple_items_allowed': True" in src + ) + ast.parse(src) + + +def test_list_param_lines_json_style(): + lines = fg._list_param_lines("symbols", "json") + assert lines == [ + " if isinstance(_query_dict.get('symbols'), str):", + " _query_dict['symbols'] = json_array(_query_dict['symbols'])", + ] + + +def _merged_cmd_spec(**extra): + return { + "url_path": "/aviation/sigmets", + "url_templates": [ + "/aviation/sigmets/{atsu}/{issueDate}", + "/aviation/sigmets/{atsu}", + "/aviation/sigmets", + ], + "template_query_params": { + "/aviation/sigmets/{atsu}/{issueDate}": [], + "/aviation/sigmets/{atsu}": [], + "/aviation/sigmets": ["issueDate", "limit"], + }, + "method": "get", + "parameters": [ + {"name": "atsu", "in": "path", "type": "string", "required": False}, + {"name": "issueDate", "in": "path", "type": "string", "required": False}, + {"name": "limit", "in": "query", "type": "integer", "default": 500}, + ], + "request_body_schema": None, + "response_schema": {"type": "object", "properties": {"x": {"type": "string"}}}, + **extra, + } + + +def _merged_spec(**extra): + return fg.FetcherCommandSpec( + name="aviation.sigmets", + cmd_spec=_merged_cmd_spec(**extra), + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + + +def test_url_choices_only_for_merged_commands(): + attributes = {"atsu": "atsu", "issueDate": "issue_date", "limit": "limit"} + assert fg.url_choices_for({"url_path": "/x/{a}"}, "", attributes) is None + choices = fg.url_choices_for(_merged_cmd_spec(), "/api", attributes) + assert choices.templates == [ + ("/api/aviation/sigmets/{atsu}/{issueDate}", ("atsu", "issueDate"), ()), + ("/api/aviation/sigmets/{atsu}", ("atsu",), ()), + ("/api/aviation/sigmets", (), ("issueDate", "limit")), + ] + assert choices.names == ["atsu", "issueDate", "limit"] + assert choices.defaults == {} + + +def test_url_choices_leave_out_urls_with_placeholders_that_have_no_field(): + cmd_spec = _merged_cmd_spec() + cmd_spec["url_templates"].append("/aviation/sigmets/key/{key}") + choices = fg.url_choices_for( + cmd_spec, "", {"atsu": "atsu", "issueDate": "issue_date", "limit": "limit"} + ) + assert all("{key}" not in template for template, _, _ in choices.templates) + assert fg.url_choices_for(cmd_spec, "", {"limit": "limit"}) is None + + +def test_url_choices_from_a_spec_without_template_query_params_keep_query_params(): + cmd_spec = _merged_cmd_spec() + del cmd_spec["template_query_params"] + choices = fg.url_choices_for( + cmd_spec, "", {"atsu": "atsu", "issueDate": "issue_date", "limit": "limit"} + ) + assert all(query == ("limit",) for _, _, query in choices.templates) + + +class _FakeResponse: + status = 200 + headers = {"Content-Type": "application/json"} + + async def read(self): + return b"[]" + + def get_encoding(self): + return "utf-8" + + async def __aenter__(self): + return self + + async def __aexit__(self, *exc): + return False + + +class _FakeSession: + def __init__(self, urls): + self.urls = urls + + async def request(self, method, url, **kwargs): + self.urls.append(url) + return _FakeResponse() + + async def __aenter__(self): + return self + + async def __aexit__(self, *exc): + return False + + +def _exec_fetcher(src: str, class_name: str, urls: list[str]): + """Exec a generated module with a fake HTTP session that records each URL.""" + import sys + import types + + from openbb_cli.dispatchers import _unpack + + utils = types.ModuleType("_generated_utils") + utils.__dict__.update(_unpack.__dict__) + sys.modules["_generated_utils"] = utils + try: + namespace: dict = {} + exec( # noqa: S102 + src.replace("from ....utils import", "from _generated_utils import"), + namespace, + ) + finally: + sys.modules.pop("_generated_utils", None) + + async def fake_session(*args, **kwargs): + return _FakeSession(urls) + + namespace["get_async_requests_session"] = fake_session + return namespace[class_name] + + +def test_merged_command_fetcher_requests_the_url_that_fits(): + import asyncio + + src = fg.generate_fetcher_module(_merged_spec()).source + assert "_path, _used, _query_names = choose_url_template(" in src + urls: list[str] = [] + fetcher = _exec_fetcher(src, "AviationSigmetsFetcher", urls) + for params in ( + {}, + {"issue_date": "2026-10-18"}, + {"atsu": "KKCI"}, + {"atsu": "KKCI", "issue_date": "2026-10-18"}, + {"atsu": "KKCI", "limit": 5}, + ): + query = fetcher.transform_query(params) + asyncio.run(fetcher.aextract_data(query, {})) + assert urls == [ + "https://x/aviation/sigmets?limit=500", + "https://x/aviation/sigmets?issueDate=2026-10-18&limit=500", + "https://x/aviation/sigmets/KKCI", + "https://x/aviation/sigmets/KKCI/2026-10-18", + "https://x/aviation/sigmets/KKCI", + ] + + +def test_merged_command_query_params_reject_values_that_form_no_url(): + src = fg.generate_fetcher_module( + _merged_spec( + template_query_params={ + "/aviation/sigmets/{atsu}/{issueDate}": [], + "/aviation/sigmets/{atsu}": [], + "/aviation/sigmets": ["limit"], + } + ) + ).source + model = _exec_query_params(src, "AviationSigmetsQueryParams") + with pytest.raises( + ValueError, match=r"Path parameters \(issue_date\) do not form a URL" + ): + model(issue_date="2026-10-18") + model(atsu="KKCI") + + +def test_single_url_fetcher_code_is_unchanged_by_template_support(): + cmd_spec = _merged_cmd_spec() + del cmd_spec["url_templates"], cmd_spec["template_query_params"] + cmd_spec["url_path"] = "/aviation/sigmets/{atsu}" + spec = fg.FetcherCommandSpec( + name="aviation.sigmets", + cmd_spec=cmd_spec, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + assert "choose_url_template" not in src + assert re.search( + r"_path = ['\"]/aviation/sigmets/\{atsu\}['\"]\.format\(atsu=getattr\(query, ['\"]atsu['\"]\)\)", + src, + ) + + +def test_streaming_fetcher_builds_path_from_placeholders(): + cmd_spec = _merged_cmd_spec(response_schemas={"200": {"text/event-stream": {}}}) + spec = fg.FetcherCommandSpec( + name="aviation.sigmets", + cmd_spec=cmd_spec, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + out = fg.generate_fetcher_module(spec) + assert out.is_streaming + assert '_url = f"https://x{_path}"' in out.source + assert "_path, _used, _query_names = choose_url_template(" in out.source + ast.parse(out.source) + + +def test_json_list_param_converts_items_to_their_type(): + lines = fg._list_param_lines("orderIds", "json", "integer") + assert lines[1] == ( + " _query_dict['orderIds'] = json_array(_query_dict['orderIds'], 'integer')" + ) + + +def test_required_group_members_with_empty_values_are_not_sent(): + import asyncio + + cmd_spec = _grouped_cmd_spec([_GROUP]) + cmd_spec["parameters"][1].update(is_list=True, list_style="json") + spec = fg.FetcherCommandSpec( + name="ticker", + cmd_spec=cmd_spec, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + urls: list[str] = [] + fetcher = _exec_fetcher( + fg.generate_fetcher_module(spec).source, "TickerFetcher", urls + ) + query = fetcher.transform_query({"symbol": "BTCUSDT", "symbols": ""}) + asyncio.run(fetcher.aextract_data(query, {})) + assert urls == ["https://x/api/v3/ticker?symbol=BTCUSDT"] + + +def test_json_list_choices_are_not_checked_as_comma_items(): + cmd_spec = _grouped_cmd_spec([]) + cmd_spec["parameters"][1].update( + is_list=True, list_style="json", choices=["SPOT", "MARGIN"] + ) + schema = fg._query_params_schema(cmd_spec, "prov") + assert "x-choices" not in schema["properties"]["symbols"] + + +def test_null_empty_marker_does_not_become_a_field_named_properties(): + """GeoJSON features have a field literally named ``properties``.""" + schema = { + "type": "object", + "properties": { + "id": {"type": "string"}, + "properties": { + "type": "object", + "properties": {"name": {"type": "string"}}, + }, + }, + } + marked = fg._mark_null_empty(schema) + assert set(marked["properties"]) == {"id", "properties"} + assert marked["x-null-empty"] is True + assert marked["properties"]["properties"]["x-null-empty"] is True + + +def test_array_of_records_with_a_nested_record_list_models_the_records(): + """Petstore ``/pet/findByStatus``: Pet rows, not their ``tags``.""" + pet = { + "type": "object", + "properties": { + "id": {"type": "integer"}, + "name": {"type": "string"}, + "tags": { + "type": "array", + "items": {"type": "object", "properties": {"id": {}, "name": {}}}, + }, + "status": {"type": "string"}, + }, + } + out = fg._data_schema({"response_schema": {"type": "array", "items": pet}}) + assert list(out["properties"]) == ["id", "name", "tags", "status"] + + +def test_module_name_for_keyword_command_gets_a_suffix(): + assert fg._module_name_from_command("class") == "class_" + assert fg._module_name_from_command("data.import") == "data_import" + assert fg._module_name_from_command("24hr") == "_24hr" + + +def _per_url_cmd_spec(): + item = { + "type": "object", + "properties": {"id": {"type": "integer"}, "owner": {"type": "string"}}, + "required": ["id"], + } + listing = { + "type": "object", + "properties": { + "pets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": {"type": "integer"}, + "name": {"type": "string"}, + }, + "required": ["id", "name"], + }, + }, + "total": {"type": "integer"}, + }, + } + return { + "url_path": "/pets", + "url_templates": ["/pets/{petId}", "/pets"], + "template_query_params": {"/pets/{petId}": [], "/pets": []}, + "template_response_schemas": {"/pets/{petId}": item}, + "method": "get", + "parameters": [{"name": "petId", "in": "path", "type": "integer"}], + "request_body_schema": None, + "response_schema": listing, + } + + +def test_merged_command_data_model_covers_every_url(): + out = fg._merged_data_schema(_per_url_cmd_spec()) + assert list(out["properties"]) == ["id", "name", "owner"] + assert out["required"] == ["id"] + + +def test_merged_command_unpacks_with_the_hint_of_the_url_it_used(): + import asyncio + + spec = fg.FetcherCommandSpec( + name="pets", + cmd_spec=_per_url_cmd_spec(), + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + assert ".get(tuple(sorted(_used)), {})" in src + urls: list[str] = [] + fetcher = _exec_fetcher(src, "PetsFetcher", urls) + bodies = iter( + [ + b'{"id": 1, "owner": "ann"}', + b'{"pets": [{"id": 1, "name": "a"}, {"id": 2, "name": "b"}], "total": 2}', + ] + ) + + async def read(self): + return next(bodies) + + original = _FakeResponse.read + _FakeResponse.read = read + try: + item = asyncio.run( + fetcher.aextract_data(fetcher.transform_query({"pet_id": 1}), {}) + ) + listing = asyncio.run(fetcher.aextract_data(fetcher.transform_query({}), {})) + finally: + _FakeResponse.read = original + assert item["rows"] == [{"id": 1, "owner": "ann"}] + assert listing["rows"] == [{"id": 1, "name": "a"}, {"id": 2, "name": "b"}] + assert listing["metadata"] == {"total": 2} + assert urls == ["https://x/pets/1", "https://x/pets"] + + +def _extract_with_body(fetcher, params, body: bytes): + import asyncio + + async def read(self): + return body + + original = _FakeResponse.read + _FakeResponse.read = read + try: + query = fetcher.transform_query(params) + return asyncio.run(fetcher.aextract_data(query, {})) + finally: + _FakeResponse.read = original + + +def test_array_of_records_fetcher_keeps_a_single_record_whole(): + order = {"type": "object", "properties": {"symbol": {"type": "string"}}} + order_list = { + "type": "object", + "properties": { + "orderListId": {"type": "integer"}, + "orders": {"type": "array", "items": order}, + }, + "required": ["orderListId"], + } + spec = fg.FetcherCommandSpec( + name="allOrderList", + cmd_spec={ + "url_path": "/allOrderList", + "method": "get", + "parameters": [], + "request_body_schema": None, + "response_schema": {"type": "array", "items": order_list}, + }, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + assert 'kind="records"' in src + fetcher = _exec_fetcher(src, "AllOrderListFetcher", []) + out = _extract_with_body( + fetcher, {}, b'[{"orderListId": 7, "orders": [{"symbol": "BTCUSDT"}]}]' + ) + assert out["rows"] == [{"orderListId": 7, "orders": [{"symbol": "BTCUSDT"}]}] + + +def test_merged_data_model_takes_every_type_a_field_is_declared_with(): + cmd_spec = _per_url_cmd_spec() + cmd_spec["template_response_schemas"]["/pets/{petId}"]["properties"]["name"] = { + "type": "array", + "items": {"type": "string"}, + } + cmd_spec["response_schema"]["properties"]["pets"]["items"]["properties"]["name"][ + "description" + ] = "Pet name." + out = fg._merged_data_schema(cmd_spec) + assert out["properties"]["name"] == { + "anyOf": [ + {"type": "string", "description": "Pet name."}, + {"type": "array", "items": {"type": "string"}}, + ], + "description": "Pet name.", + } + + +def _flag_spec(**extra_params): + return fg.FetcherCommandSpec( + name="flags", + cmd_spec={ + "url_path": "/flags/{active}", + "method": "get", + "parameters": [ + {"name": "active", "in": "path", "type": "boolean", "required": True}, + *extra_params.values(), + ], + "request_body_schema": None, + "response_schema": {"type": "object", "properties": {"ok": {}}}, + }, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + + +def test_single_url_fetcher_sends_boolean_path_values_lowercase(): + src = fg.generate_fetcher_module(_flag_spec()).source + assert "wire_value" in _utils_import(src) + urls: list[str] = [] + fetcher = _exec_fetcher(src, "FlagsFetcher", urls) + _extract_with_body(fetcher, {"active": True}, b'{"ok": 1}') + assert urls == ["https://x/flags/true"] + + +def test_renamed_query_field_is_read_back_under_its_field_name(): + spec = fg.FetcherCommandSpec( + name="items", + cmd_spec={ + "url_path": "/items/{ID}", + "method": "get", + "parameters": [ + {"name": "ID", "in": "path", "type": "string", "required": True}, + {"name": "id", "in": "query", "type": "string"}, + ], + "request_body_schema": None, + "response_schema": {"type": "object", "properties": {"ok": {}}}, + }, + base_url="https://x", + api_prefix="", + provider_name="prov", + ) + src = fg.generate_fetcher_module(spec).source + urls: list[str] = [] + fetcher = _exec_fetcher(src, "ItemsFetcher", urls) + _extract_with_body(fetcher, {"ID": "A1", "id": "x"}, b'{"ok": 1}') + assert urls == ["https://x/items/A1?id=x"] + + +def test_merged_data_model_keeps_one_type_when_urls_differ_only_in_docs(): + cmd_spec = _per_url_cmd_spec() + item = cmd_spec["template_response_schemas"]["/pets/{petId}"] + item["properties"]["name"] = {"type": "string", "example": "rex"} + out = fg._merged_data_schema(cmd_spec) + assert out["properties"]["name"] == {"type": "string"} + + +def test_streaming_fetcher_sends_boolean_path_values_lowercase(): + spec = _flag_spec() + spec.cmd_spec["response_schemas"] = {"200": {"text/event-stream": {}}} + out = fg.generate_fetcher_module(spec) + assert out.is_streaming + assert "wire_value" in _utils_import(out.source) + assert "active=wire_value(getattr(query, 'active'))" in out.source + ast.parse(out.source) + + +def test_fetcher_without_boolean_path_values_does_not_import_wire_value(): + spec = _flag_spec() + spec.cmd_spec["parameters"][0]["type"] = "string" + assert "wire_value" not in fg.generate_fetcher_module(spec).source + spec.cmd_spec["response_schemas"] = {"200": {"text/event-stream": {}}} + assert "wire_value" not in fg.generate_fetcher_module(spec).source + + +def _utils_import(source: str) -> str: + return next(line for line in source.splitlines() if "from ....utils import" in line) + + +def test_merged_data_model_counts_doc_and_nullable_variants_as_one(): + cmd_spec = _per_url_cmd_spec() + obj = {"type": "object", "properties": {"url": {"type": "string"}}} + listing_row = cmd_spec["response_schema"]["properties"]["pets"]["items"] + listing_row["properties"]["photo"] = {**obj, "example": {"url": "a"}} + item = cmd_spec["template_response_schemas"]["/pets/{petId}"] + item["properties"]["photo"] = { + "anyOf": [{**obj, "example": {"url": "b"}}, {"type": "null"}] + } + cmd_spec["url_templates"].append("/pets/{petId}/tags") + cmd_spec["template_query_params"]["/pets/{petId}/tags"] = [] + cmd_spec["template_response_schemas"]["/pets/{petId}/tags"] = { + "type": "object", + "properties": { + "id": {"type": "integer"}, + "photo": {"type": "array", "items": {"type": "string"}}, + }, + } + photo = fg._merged_data_schema(cmd_spec)["properties"]["photo"] + assert photo == { + "anyOf": [ + {**obj, "example": {"url": "a"}}, + {"type": "array", "items": {"type": "string"}}, + ], + "example": {"url": "a"}, + } + + +def test_merged_data_model_ignores_nested_nullability_differences(): + cmd_spec = _per_url_cmd_spec() + row = cmd_spec["response_schema"]["properties"]["pets"]["items"] + row["properties"]["owner"] = { + "type": "object", + "properties": {"city": {"type": "string"}}, + } + item = cmd_spec["template_response_schemas"]["/pets/{petId}"] + item["properties"]["owner"] = { + "type": "object", + "properties": {"city": {"anyOf": [{"type": "string"}, {"type": "null"}]}}, + } + owner = fg._merged_data_schema(cmd_spec)["properties"]["owner"] + assert owner == row["properties"]["owner"] diff --git a/cli/tests/test_codegen_package_gen.py b/cli/tests/test_codegen_package_gen.py index 36433ab2176..c7845c8a855 100644 --- a/cli/tests/test_codegen_package_gen.py +++ b/cli/tests/test_codegen_package_gen.py @@ -721,3 +721,71 @@ def test_router_import_cycles_are_rejected(): selfref = GeneratedRouter("c", None, "from p.routers.c import router\n") with pytest.raises(ValueError, match="Circular router import"): _assert_unique_router_modules([selfref]) + + +def test_generated_package_readme_lists_mounted_command_paths(tmp_path): + """README paths match the router functions, not the raw spec names.""" + command = _spec_with_get_command()["commands"]["equity.search"] + spec = { + "base_url": "https://api.example.com/", + "api_prefix": "", + "commands": { + "pet": {**command, "url_path": "/pet"}, + "pet.findByStatus": {**command, "url_path": "/pet/findByStatus"}, + "ticker.24hr": {**command, "url_path": "/ticker/24hr"}, + }, + } + out = pkg.generate_packages(spec, output_root=tmp_path, provider_name="fmp") + readme = out.packages[0]._readme() + assert "`obb.fmp.pet.pet` — provider: `fmp`" in readme + assert "`obb.fmp.pet.findbystatus` — provider: `fmp`" in readme + assert "`obb.fmp.ticker._24hr` — provider: `fmp`" in readme + assert "findByStatus`" not in readme + assert "ticker.24hr" not in readme + + +def test_exploded_object_param_flows_from_openapi_to_generated_package(tmp_path): + """One OpenAPI object parameter with a ``oneOf`` becomes two arguments, + a QueryParams validator, and a generated test that satisfies it.""" + import ast + + from openbb_cli.dispatchers.spec import build_spec_document + + openapi = { + "openapi": "3.0.2", + "paths": { + "/ticker": { + "get": { + "parameters": [ + { + "name": "selection", + "in": "query", + "required": True, + "schema": { + "type": "object", + "properties": { + "symbol": {"type": "string", "example": "BNBUSDT"}, + "symbols": {"type": "string"}, + }, + "oneOf": [ + {"required": ["symbol"]}, + {"required": ["symbols"]}, + ], + }, + } + ], + "responses": {"200": {"description": "ok"}}, + } + } + }, + } + doc = build_spec_document(openapi, base_url="https://x.test") + out = pkg.generate_packages(doc, output_root=tmp_path, provider_name="ex") + package = out.packages[0] + [fetcher] = package.fetchers_by_provider["ex"] + assert "symbol: str | None" in fetcher.source + assert "symbols: str | None" in fetcher.source + assert "_check_required_groups" in fetcher.source + ast.parse(fetcher.source) + [tests] = package.test_modules + assert "params = {'symbol': 'BNBUSDT'}" in tests.source diff --git a/cli/tests/test_codegen_post_gen.py b/cli/tests/test_codegen_post_gen.py index 66eef051896..98ab9ad2d92 100644 --- a/cli/tests/test_codegen_post_gen.py +++ b/cli/tests/test_codegen_post_gen.py @@ -632,6 +632,31 @@ def test_generate_post_command_module_with_path_params_emits_format_call(): assert "'/x/{slug}'.format(slug=slug)" in out.source +def test_post_module_sends_boolean_path_values_lowercase(): + spec = pg.PostCommandSpec( + name="x.y", + cmd_spec={ + "url_path": "/x/{active}", + "method": "post", + "parameters": [ + {"name": "active", "in": "path", "type": "boolean", "required": True}, + ], + "request_body_schema": {"type": "object", "properties": {}}, + "response_schema": {"type": "object"}, + }, + base_url="https://api.example.com", + api_prefix="", + provider_name="tools", + ) + out = pg.generate_post_command_module(spec) + assert "'/x/{active}'.format(active=wire_value(active))" in out.source + assert "wire_value" in next( + line for line in out.source.splitlines() if "from ....utils import" in line + ) + spec.cmd_spec["parameters"][0]["type"] = "string" + assert "wire_value" not in pg.generate_post_command_module(spec).source + + def test_generate_post_command_module_with_credentials_renders_cred_block(): spec = pg.PostCommandSpec( name="x.y", @@ -977,3 +1002,72 @@ def test_envelope_inner_schema_single_scalar_array_is_not_an_envelope(): "tags": {"type": "array", "items": {"type": "string"}}, } assert pg._envelope_inner_schema({"type": "object"}, props) is None + + +def test_merged_post_command_chooses_url_and_keeps_path_values_out_of_query(): + spec = pg.PostCommandSpec( + name="search", + cmd_spec={ + "url_path": "/search", + "url_templates": ["/search/{index}", "/search"], + "template_query_params": {"/search/{index}": [], "/search": ["limit"]}, + "method": "post", + "parameters": [ + {"name": "index", "in": "path", "type": "string", "required": False}, + {"name": "limit", "in": "query", "type": "integer", "required": False}, + ], + "request_body_schema": { + "type": "object", + "properties": {"q": {"type": "string"}}, + }, + "response_schema": {"type": "object"}, + }, + base_url="https://api.example.com", + api_prefix="", + provider_name="tools", + ) + src = pg.generate_post_command_module(spec).source + assert "_path, _used, _query_names = choose_url_template(" in src + assert "if _name in _used or _name not in _query_names" in src + assert ( + "from ....utils import choose_url_template" in src + or "choose_url_template," in src + ) + ast.parse(src) + + +def test_post_command_sends_json_list_query_param_as_json_array(): + spec = pg.PostCommandSpec( + name="orders", + cmd_spec={ + "url_path": "/orders", + "method": "post", + "parameters": [ + { + "name": "symbols", + "in": "query", + "type": "string", + "is_list": True, + "list_style": "json", + }, + ], + "request_body_schema": { + "type": "object", + "properties": {"q": {"type": "string"}}, + }, + "response_schema": {"type": "object"}, + }, + base_url="https://api.example.com", + api_prefix="", + provider_name="tools", + ) + src = pg.generate_post_command_module(spec).source + assert ( + "_value = json_array(symbols if isinstance(symbols, str) else _json.dumps(list(symbols)))" + in src + ) + ast.parse(src) + + +def test_post_module_name_for_keyword_command_gets_a_suffix(): + assert pg._module_name_from_command("import") == "import_" diff --git a/cli/tests/test_codegen_project_gen.py b/cli/tests/test_codegen_project_gen.py index 7ff082bc7ca..f120820c978 100644 --- a/cli/tests/test_codegen_project_gen.py +++ b/cli/tests/test_codegen_project_gen.py @@ -109,3 +109,15 @@ def test_generate_pyproject_omits_provenance_block_when_empty(): spec_provenance={"source_url": "", "api_version": ""}, ) assert "[tool.openbb-codegen]" not in out.source + + +def test_generate_pyproject_ruff_config_ignores_ambiguous_field_names(): + """Upstream schemas name fields ``l`` (low, last id); E741 would flag every one.""" + out = pg.generate_pyproject( + project_name="openbb-codegen", + package_name="openbb_codegen", + providers=["fmp"], + routers=[], + description="Generated extension.", + ) + assert '"E501", "E741", "B008",' in out.source diff --git a/cli/tests/test_codegen_pydantic_gen.py b/cli/tests/test_codegen_pydantic_gen.py index 5aa08252033..3cd56e1d760 100644 --- a/cli/tests/test_codegen_pydantic_gen.py +++ b/cli/tests/test_codegen_pydantic_gen.py @@ -3,6 +3,7 @@ from __future__ import annotations import ast +import re import pytest @@ -1038,3 +1039,207 @@ def test_union_of_untitled_object_variants_keeps_distinct_classes(): assert "city:" in src and "type:" in src ast.parse(src) assert len({line for line in src.splitlines() if line.startswith("class ")}) >= 3 + + +def _groups_class(): + schema = { + "type": "object", + "properties": { + "symbol": {"type": "string"}, + "symbols": {"type": "string"}, + "startTime": {"type": "integer"}, + "endTime": {"type": "integer"}, + }, + "x-required-groups": [ + { + "combinator": "oneOf", + "alternatives": [["symbol"], ["symbols"]], + "members": ["symbol", "symbols"], + "required": True, + }, + { + "combinator": "anyOf", + "alternatives": [["startTime", "endTime"]], + "members": ["startTime", "endTime"], + "required": False, + }, + ], + } + cls = pg.generate_class( + schema, class_name="TickerQueryParams", base_class="QueryParams" + ) + rendered = ( + "from openbb_core.provider.abstract.query_params import QueryParams\n" + + pg.render_module(cls) + ) + ast.parse(rendered) + namespace: dict = {} + exec(rendered, namespace) # noqa: S102 + return cls, namespace["TickerQueryParams"] + + +def test_required_groups_validator_renders_with_field_names(): + cls, _ = _groups_class() + assert "from pydantic import model_validator" in cls.imports + assert "def _check_required_groups(self) -> Any:" in cls.source + assert "for _names in (('symbol',), ('symbols',))" in cls.source + assert "for _name in ('start_time', 'end_time')" in cls.source + + +@pytest.mark.parametrize( + "kwargs", + [ + {"symbol": "BTCUSDT"}, + {"symbols": '["BTCUSDT"]'}, + {"symbol": "BTCUSDT", "start_time": 1, "end_time": 2}, + ], +) +def test_required_groups_validator_accepts_valid_combinations(kwargs): + _, model = _groups_class() + model(**kwargs) + + +@pytest.mark.parametrize( + "kwargs,message", + [ + ({}, "Pass exactly one of: symbol | symbols"), + ({"symbol": "A", "symbols": "B"}, "Pass exactly one of: symbol | symbols"), + ( + {"symbol": "A", "start_time": 1}, + "Pass at least one of: (start_time, end_time)", + ), + ], +) +def test_required_groups_validator_rejects_invalid_combinations(kwargs, message): + _, model = _groups_class() + with pytest.raises(ValueError, match=re.escape(message)): + model(**kwargs) + + +def test_generate_class_without_required_groups_has_no_validator(): + cls = pg.generate_class( + {"type": "object", "properties": {"a": {"type": "string"}}}, + class_name="Plain", + base_class="QueryParams", + ) + assert "_check_required_groups" not in cls.source + assert "from pydantic import model_validator" not in cls.imports + + +def test_required_groups_validator_treats_empty_values_as_not_passed(): + _, model = _groups_class() + with pytest.raises( + ValueError, match=re.escape("Pass exactly one of: symbol | symbols") + ): + model(symbol="", symbols="") + model(symbol="A", symbols="") + + +def test_required_groups_enforced_when_names_differ_only_in_case(): + schema = { + "type": "object", + "properties": {"Symbol": {"type": "string"}, "symbol": {"type": "string"}}, + "x-required-groups": [ + { + "combinator": "oneOf", + "alternatives": [["Symbol"], ["symbol"]], + "members": ["Symbol", "symbol"], + "required": True, + } + ], + } + cls = pg.generate_class(schema, class_name="Q", base_class="QueryParams") + rendered = ( + "from openbb_core.provider.abstract.query_params import QueryParams\n" + + pg.render_module(cls) + ) + namespace: dict = {} + exec(rendered, namespace) # noqa: S102 + model = namespace["Q"] + assert model(Symbol="A").symbol_ == "A" + assert model(symbol="a").symbol == "a" + with pytest.raises(ValueError, match="Pass exactly one of"): + model(Symbol="A", symbol="a") + + +def test_field_named_after_a_builtin_its_class_annotates_with_is_renamed(): + schema = { + "type": "object", + "properties": { + "list": {"type": "array", "items": {"type": "string"}}, + "type": {"type": "string"}, + }, + } + cls = pg.generate_class(schema, class_name="Stats", base_class="BaseModel") + assert "list_: list[str] | None" in cls.source + assert "alias='list'" in cls.source or 'alias="list"' in cls.source + assert " type: str | None" in cls.source + namespace: dict = {} + exec(pg.render_module(cls), namespace) # noqa: S102 + assert namespace["Stats"](**{"list": ["a"]}).list_ == ["a"] + + +def test_field_named_after_a_builtin_no_annotation_uses_keeps_its_name(): + schema = {"type": "object", "properties": {"list": {"type": "string"}}} + cls = pg.generate_class(schema, class_name="Plain", base_class="BaseModel") + assert " list: str | None" in cls.source + + +def test_colliding_property_names_get_distinct_fields(): + """JSON-LD ``@id`` beside ``id``: the exact name keeps ``id``.""" + schema = { + "type": "object", + "properties": {"@id": {"type": "string"}, "id": {"type": "string"}}, + } + cls = pg.generate_class(schema, class_name="Product", base_class="BaseModel") + namespace: dict = {} + exec(pg.render_module(cls), namespace) # noqa: S102 + row = namespace["Product"](**{"@id": "urn:1", "id": "1"}) + assert (row.id, row.id_) == ("1", "urn:1") + + +def test_builtin_name_inside_a_literal_value_does_not_rename_a_field(): + schema = { + "type": "object", + "properties": { + "list": {"type": "string"}, + "view": {"type": "string", "enum": ["list", "grid"]}, + }, + } + cls = pg.generate_class(schema, class_name="Q", base_class="QueryParams") + assert " list: str | None" in cls.source + assert pg.query_params_field_names(schema["properties"], "Q")["list"] == "list" + + +def test_optional_group_ignores_members_left_at_their_default(): + schema = { + "type": "object", + "properties": { + "symbol": {"type": "string"}, + "isin": {"type": "string"}, + "limit": {"type": "integer", "default": 10}, + }, + "x-required-groups": [ + { + "combinator": "oneOf", + "alternatives": [["symbol"], ["isin"]], + "members": ["symbol", "isin", "limit"], + "required": False, + } + ], + } + cls = pg.generate_class(schema, class_name="Q", base_class="QueryParams") + rendered = ( + "from openbb_core.provider.abstract.query_params import QueryParams\n" + + pg.render_module(cls) + ) + namespace: dict = {} + exec(rendered, namespace) # noqa: S102 + model = namespace["Q"] + model() + model(limit=10) + model(symbol="AAPL", limit=5) + with pytest.raises( + ValueError, match=re.escape("Pass exactly one of: symbol | isin") + ): + model(limit=5) diff --git a/cli/tests/test_codegen_router_gen.py b/cli/tests/test_codegen_router_gen.py index 11f55459008..c4623fef310 100644 --- a/cli/tests/test_codegen_router_gen.py +++ b/cli/tests/test_codegen_router_gen.py @@ -34,6 +34,23 @@ def test_safe_segment_handles_special_chars_and_empty(): assert rg._safe_segment("Fixed-Income") == "fixed_income" +def test_mounted_command_paths_mirror_router_naming(): + tree = nt.build_namespace_tree( + { + "api.v3.aggTrades": {}, + "api.v3.ticker": {}, + "api.v3.ticker.24hr": {}, + "bulk-fundamentals": {}, + } + ) + assert rg.mounted_command_paths(tree) == { + "api.v3.aggTrades": "api.v3.aggtrades", + "api.v3.ticker": "api.v3.ticker.ticker", + "api.v3.ticker.24hr": "api.v3.ticker._24hr", + "bulk-fundamentals": "bulk_fundamentals", + } + + def test_module_name_for_joins_dotted_path(): assert rg._module_name_for("equity") == "equity" assert rg._module_name_for("equity.price") == "equity_price" diff --git a/cli/tests/test_codegen_test_gen.py b/cli/tests/test_codegen_test_gen.py index 75190f2b1c4..1767432ab13 100644 --- a/cli/tests/test_codegen_test_gen.py +++ b/cli/tests/test_codegen_test_gen.py @@ -42,6 +42,20 @@ def _spec_with_choices_and_default(): def test_spec_supplied_value_prefers_example_over_everything(): + assert ( + tg._spec_supplied_value( + { + "example": "AMZN", + "default": "GOOG", + "choices": ["GOOG", "AMZN"], + } + ) + == "AMZN" + ) + assert tg._spec_supplied_value({"example": "AAPL", "default": "MSFT"}) == "AAPL" + + +def test_spec_supplied_value_skips_example_and_default_outside_choices(): assert ( tg._spec_supplied_value( { @@ -50,7 +64,21 @@ def test_spec_supplied_value_prefers_example_over_everything(): "choices": ["GOOG", "AMZN"], } ) - == "AAPL" + == "GOOG" + ) + assert ( + tg._spec_supplied_value( + {"example": "AAPL", "default": "AMZN", "choices": ["GOOG", "AMZN"]} + ) + == "AMZN" + ) + + +def test_spec_supplied_value_skips_quoted_example_outside_choices(): + """Binance's klines spec gives ``interval`` the example ``'"1m"'``.""" + assert ( + tg._spec_supplied_value({"example": '"1m"', "choices": ["1s", "1m", "1h"]}) + == "1s" ) @@ -119,6 +147,214 @@ def test_derive_test_params_returns_none_when_required_param_has_no_supplied_val assert tg._derive_test_params(cmd, "fmp") is None +def _grouped(alternatives, combinator="oneOf", required=True, params=None): + members = sorted({name for alt in alternatives for name in alt}) + return { + "parameters": params + or [ + {"name": "symbol", "example": "BNBUSDT"}, + {"name": "symbols", "example": '["BTCUSDT"]'}, + {"name": "windowSize"}, + ], + "required_groups": [ + { + "combinator": combinator, + "alternatives": alternatives, + "members": members, + "required": required, + } + ], + } + + +def test_derive_test_params_fills_first_fillable_alternative(): + spec = _grouped([["symbol"], ["symbols"]]) + assert tg._derive_test_params(spec, "binance") == {"symbol": "BNBUSDT"} + spec = _grouped([["windowSize"], ["symbols"]], combinator="anyOf") + assert tg._derive_test_params(spec, "binance") == {"symbols": '["BTCUSDT"]'} + + +def test_derive_test_params_skips_test_when_no_alternative_is_fillable(): + spec = _grouped([["windowSize"], ["missing"]]) + assert tg._derive_test_params(spec, "binance") is None + + +def test_derive_test_params_leaves_absent_optional_group_alone(): + spec = _grouped([["symbol"], ["symbols"]], required=False) + assert tg._derive_test_params(spec, "binance") == {} + + +def test_derive_test_params_keeps_exactly_one_one_of_alternative(): + """The date heuristic fills both dates; oneOf keeps only the first.""" + params = [{"name": "startDate"}, {"name": "endDate"}] + spec = _grouped([["startDate"], ["endDate"]], params=params) + out = tg._derive_test_params(spec, "binance") + assert list(out) == ["start_date"] + spec = _grouped([["startDate"], ["endDate"]], combinator="anyOf", params=params) + assert list(tg._derive_test_params(spec, "binance")) == ["start_date", "end_date"] + + +def test_derive_test_params_one_of_with_nested_alternatives(): + params = [{"name": "a", "example": "A"}, {"name": "b", "example": "B"}] + spec = _grouped([["a", "b"], ["a"]], params=params) + assert tg._derive_test_params(spec, "binance") == {"a": "A"} + + +def test_derive_test_params_never_drops_a_required_param(): + params = [ + {"name": "symbol", "required": True, "example": "BTCUSDT"}, + {"name": "date"}, + ] + spec = _grouped([["date"], ["symbol"]], params=params) + assert tg._derive_test_params(spec, "binance") == {"symbol": "BTCUSDT"} + params = [ + {"name": "symbol", "required": True, "example": "BTCUSDT"}, + {"name": "symbols", "required": True, "example": "X"}, + ] + spec = _grouped([["symbol"], ["symbols"]], params=params) + assert tg._derive_test_params(spec, "binance") is None + + +def test_derive_test_params_solves_groups_together(): + """oneOf [a|b] plus anyOf [b|c]: {b} meets both, though filling a first does not.""" + params = [ + {"name": "a", "example": "A"}, + {"name": "b", "example": "B"}, + {"name": "c"}, + ] + spec = _grouped([["a"], ["b"]], params=params) + spec["required_groups"].append( + { + "combinator": "anyOf", + "alternatives": [["b"], ["c"]], + "members": ["b", "c"], + "required": True, + } + ) + assert tg._derive_test_params(spec, "binance") == {"b": "B"} + + +def test_derive_test_params_skips_test_when_groups_truly_conflict(): + params = [{"name": "a", "example": "A"}, {"name": "b", "example": "B"}] + spec = _grouped([["a"], ["b"]], params=params) + spec["required_groups"].append( + { + "combinator": "anyOf", + "alternatives": [["a", "b"]], + "members": ["a", "b"], + "required": True, + } + ) + assert tg._derive_test_params(spec, "binance") is None + + +def test_derive_test_params_fills_a_merged_url_when_none_fits(): + """No URL is free of placeholders, so the test fills the first it can.""" + cmd = { + "url_path": "/orders/{orderId}", + "url_templates": ["/orders/{orderId}", "/{account}/orders"], + "template_query_params": {"/orders/{orderId}": [], "/{account}/orders": []}, + "parameters": [ + {"name": "orderId", "in": "path", "required": False}, + {"name": "account", "in": "path", "required": False, "example": "acct"}, + ], + } + assert tg._derive_test_params(cmd, "prov") == {"account": "acct"} + cmd["parameters"][1].pop("example") + assert tg._derive_test_params(cmd, "prov") is None + + +def test_derive_test_params_date_heuristic_skips_any_url_placeholder(): + """The merged ``date`` kept its query copy, but another URL uses it as a segment.""" + cmd = { + "url_path": "/obs/{station}", + "url_templates": ["/obs/{station}", "/obs/{date}"], + "template_query_params": {"/obs/{station}": ["date"], "/obs/{date}": []}, + "parameters": [ + {"name": "station", "in": "path", "required": False, "example": "KPHX"}, + {"name": "date", "in": "query", "required": False}, + ], + } + out = tg._derive_test_params(cmd, "prov") + assert "date" not in out + + +def test_derive_test_params_disarms_optional_group_set_off_by_heuristic_dates(): + params = [{"name": "startDate"}, {"name": "symbol"}] + spec = _grouped([["symbol"]], combinator="anyOf", required=False, params=params) + spec["required_groups"][0]["members"] = ["startDate", "symbol"] + assert tg._derive_test_params(spec, "binance") == {} + + +def test_derive_test_params_reuses_heuristic_value_inside_an_alternative(): + params = [{"name": "symbol", "example": "BTCUSDT"}, {"name": "date"}] + spec = _grouped([["symbol", "date"]], combinator="anyOf", params=params) + out = tg._derive_test_params(spec, "binance") + assert set(out) == {"symbol", "date"} + assert out["symbol"] == "BTCUSDT" + + +def test_derive_test_params_keys_are_query_params_field_names(): + """``Fetcher.test`` reads each key back with ``getattr`` on the query.""" + from openbb_cli.codegen.fetcher_gen import _query_params_schema + from openbb_cli.codegen.pydantic_gen import generate_class, render_module + + cmd = { + "parameters": [ + { + "name": "operationType", + "type": "string", + "required": True, + "example": "all", + }, + {"name": "cwsu-id", "type": "string", "required": True, "example": "ZAB"}, + {"name": "startDate", "type": "string"}, + ] + } + out = tg._derive_test_params(cmd, "prov") + assert set(out) == {"operation_type", "cwsu_id", "start_date"} + cls = generate_class( + _query_params_schema(cmd, "prov"), class_name="Q", base_class="QueryParams" + ) + namespace: dict = {} + exec( # noqa: S102 + "from openbb_core.provider.abstract.query_params import QueryParams\n" + + render_module(cls), + namespace, + ) + query = namespace["Q"](**out) + assert all(getattr(query, key) == value for key, value in out.items()) + + +def test_derive_test_params_date_heuristic_skips_params_with_choices(): + """``date_type`` (trade | maturity) is not a date; filling it fails validation.""" + cmd = { + "parameters": [ + {"name": "date_type", "type": "string", "choices": ["trade", "maturity"]}, + {"name": "startDate", "type": "string"}, + ] + } + assert set(tg._derive_test_params(cmd, "prov")) == {"start_date"} + + +def test_derive_test_params_date_heuristic_skips_path_params(): + """A merged command's optional ``{date}`` belongs to another URL, not this test.""" + cmd = { + "parameters": [ + {"name": "cwsuId", "in": "path", "required": True, "example": "ZAB"}, + {"name": "date", "in": "path", "required": False}, + {"name": "startDate", "in": "query"}, + ] + } + assert set(tg._derive_test_params(cmd, "prov")) == {"cwsu_id", "start_date"} + + +def test_spec_supplied_value_joins_list_example_for_list_query_param(): + param = {"name": "symbols", "in": "query", "is_list": True, "example": ["A", "B"]} + assert tg._spec_supplied_value(param) == "A,B" + assert tg._spec_supplied_value({**param, "is_list": False}) == ["A", "B"] + + def test_derive_test_params_skips_provider_discriminator(): cmd = { "parameters": [ @@ -209,8 +445,8 @@ def test_derive_test_params_includes_optional_date_params_with_current_date(): from datetime import date, timedelta assert out["scope"] == "all" - assert out["startDate"] == str(date.today() - timedelta(days=30)) - assert out["endDate"] == str(date.today()) + assert out["start_date"] == str(date.today() - timedelta(days=30)) + assert out["end_date"] == str(date.today()) def test_derive_test_params_skips_optional_param_without_date_shape_or_required(): @@ -540,3 +776,24 @@ def test_snake_handles_multi_word_camelcase(): ) assert tg._snake("XYZFetcher") == "xyzfetcher" assert tg._snake("simple") == "simple" + + +def test_normalize_to_module_matches_keyword_suffix(): + assert tg._normalize_to_module("class") == "class_" + + +def test_derive_test_params_keys_renamed_fields_by_their_field_name(): + cmd_spec = { + "url_path": "/items/{ID}", + "parameters": [ + { + "name": "ID", + "in": "path", + "type": "string", + "required": True, + "example": "A1", + }, + {"name": "id", "in": "query", "type": "string"}, + ], + } + assert tg._derive_test_params(cmd_spec, "prov", "ItemsQueryParams") == {"id_": "A1"} diff --git a/cli/tests/test_dispatchers_http.py b/cli/tests/test_dispatchers_http.py index 0e5c3a534d0..f84a155da66 100644 --- a/cli/tests/test_dispatchers_http.py +++ b/cli/tests/test_dispatchers_http.py @@ -1,6 +1,7 @@ """Tests for openbb_cli.dispatchers.http — HttpDispatcher against openbb-platform-api.""" import json +import re import httpx import pytest @@ -2959,3 +2960,289 @@ async def test_dispatch_date_snapshot_skipped_when_limit_zero_or_invalid(): await d.dispatch(Request(command="ds", params={})) finally: await d.aclose() + + +def test_partition_params_sends_json_list_style_as_json_array(): + d = HttpDispatcher( + "http://test", + spec_doc={ + "commands": { + "ticker.price": { + "parameters": [ + { + "name": "symbols", + "in": "query", + "is_list": True, + "list_style": "json", + } + ] + } + } + }, + ) + for value in (["BTCUSDT", "ETHUSDT"], "BTCUSDT,ETHUSDT", '["BTCUSDT","ETHUSDT"]'): + query, _, _ = d._partition_params("ticker.price", {"symbols": value}) + assert query == {"symbols": '["BTCUSDT","ETHUSDT"]'} + + +def _sigmets_dispatcher(handler): + transport = httpx.MockTransport(handler) + client = httpx.AsyncClient(transport=transport, base_url="http://t") + templates = ["/sigmets/{atsu}/{date}", "/sigmets/{atsu}", "/sigmets"] + return HttpDispatcher( + "http://t", + client=client, + command_methods={"sigmets": "get"}, + command_url_paths={"sigmets": templates}, + spec_doc={ + "commands": { + "sigmets": { + "url_path": "/sigmets", + "url_templates": templates, + "template_query_params": { + "/sigmets/{atsu}/{date}": [], + "/sigmets/{atsu}": [], + "/sigmets": ["date", "limit"], + }, + "parameters": [ + {"name": "atsu", "in": "path"}, + {"name": "date", "in": "path"}, + {"name": "limit", "in": "query", "default": 500}, + ], + } + } + }, + ) + + +@pytest.mark.asyncio +async def test_dispatch_sends_only_the_query_params_the_chosen_url_declares(): + captured = [] + + def handler(request: httpx.Request) -> httpx.Response: + captured.append(str(request.url)) + return httpx.Response(200, json={}) + + d = _sigmets_dispatcher(handler) + try: + await d.dispatch( + Request(command="sigmets", params={"date": "2026-10-18", "limit": 500}) + ) + await d.dispatch( + Request( + command="sigmets", + params={"atsu": "KKCI", "date": "2026-10-18", "limit": 500}, + ) + ) + await d.dispatch(Request(command="sigmets", params={"limit": 500})) + finally: + await d.aclose() + assert captured == [ + "http://t/sigmets?date=2026-10-18&limit=500", + "http://t/sigmets/KKCI/2026-10-18", + "http://t/sigmets?limit=500", + ] + + +@pytest.mark.asyncio +async def test_dispatch_spec_without_template_query_params_keeps_query_fallback(): + captured = [] + + def handler(request: httpx.Request) -> httpx.Response: + captured.append(str(request.url)) + return httpx.Response(200, json={}) + + d = _sigmets_dispatcher(handler) + del d._spec_doc["commands"]["sigmets"]["template_query_params"] + try: + await d.dispatch(Request(command="sigmets", params={"date": "2026-10-18"})) + await d.dispatch( + Request(command="sigmets", params={"atsu": "KKCI", "date": "2026-10-18"}) + ) + finally: + await d.aclose() + assert captured == [ + "http://t/sigmets?date=2026-10-18", + "http://t/sigmets/KKCI/2026-10-18", + ] + + +@pytest.mark.asyncio +async def test_dispatch_argparse_boolean_default_does_not_pick_or_block_a_url(): + captured = [] + + def handler(request: httpx.Request) -> httpx.Response: + captured.append(str(request.url)) + return httpx.Response(200, json={}) + + transport = httpx.MockTransport(handler) + client = httpx.AsyncClient(transport=transport, base_url="http://t") + templates = ["/v/{n}/{flag}", "/v"] + d = HttpDispatcher( + "http://t", + client=client, + command_methods={"v": "get"}, + command_url_paths={"v": templates}, + spec_doc={ + "commands": { + "v": { + "url_templates": templates, + "template_query_params": {"/v/{n}/{flag}": [], "/v": ["q"]}, + "parameters": [ + {"name": "n", "in": "path"}, + {"name": "flag", "in": "path", "type": "boolean"}, + {"name": "q", "in": "query"}, + ], + } + } + }, + ) + try: + await d.dispatch(Request(command="v", params={"flag": False, "q": "a"})) + await d.dispatch(Request(command="v", params={"n": 3, "flag": True})) + finally: + await d.aclose() + assert captured == ["http://t/v?q=a", "http://t/v/3/true"] + + +@pytest.mark.asyncio +async def test_dispatch_rejects_path_values_that_form_no_url_without_a_request(): + def handler(request: httpx.Request) -> httpx.Response: + raise AssertionError(f"unexpected request to {request.url}") + + transport = httpx.MockTransport(handler) + client = httpx.AsyncClient(transport=transport, base_url="http://t") + d = HttpDispatcher( + "http://t", + client=client, + command_methods={"cwas": "get"}, + command_url_paths={"cwas": ["/cwas/{id}", "/cwas/{id}/{date}/{seq}"]}, + ) + try: + resp = await d.dispatch( + Request(command="cwas", params={"id": "ZAB", "date": "2026-10-18"}) + ) + finally: + await d.aclose() + assert not resp.ok + assert "do not form a URL" in resp.error.message + + +def test_partition_params_json_list_from_argparse_lists_and_typed_items(): + d = HttpDispatcher( + "http://test", + spec_doc={ + "commands": { + "orders": { + "parameters": [ + { + "name": "symbols", + "in": "query", + "is_list": True, + "list_style": "json", + }, + { + "name": "ids", + "in": "query", + "is_list": True, + "list_style": "json", + "type": "integer", + }, + ] + } + } + }, + ) + cases = [ + ({"symbols": ['["BTCUSDT","ETHUSDT"]']}, {"symbols": '["BTCUSDT","ETHUSDT"]'}), + ({"symbols": ["BTCUSDT,ETHUSDT"]}, {"symbols": '["BTCUSDT","ETHUSDT"]'}), + ({"symbols": ["BTCUSDT", "ETHUSDT"]}, {"symbols": '["BTCUSDT","ETHUSDT"]'}), + ({"ids": [1, 2]}, {"ids": "[1,2]"}), + ({"ids": "1,2"}, {"ids": "[1,2]"}), + ({"symbols": ""}, {}), + ({"symbols": [""]}, {}), + ({"symbols": [" "]}, {}), + ] + for params, expected in cases: + query, _, _ = d._partition_params("orders", params) + assert query == expected, params + + +def test_shape_result_keeps_a_single_positional_row_whole(): + from openbb_cli.dispatchers.http import _shape_result + + cmd_spec = { + "response_schema": { + "type": "array", + "items": {"type": "array", "items": {"type": "string"}}, + } + } + assert _shape_result([[1, "a", "b"]], cmd_spec) == [[1, "a", "b"]] + assert _shape_result([[1, "a"], [2, "b"]], cmd_spec) == [[1, "a"], [2, "b"]] + + +def test_check_required_groups_ignores_optional_members_at_their_default(): + from openbb_cli.dispatchers.http import _check_required_groups + + cmd_spec = { + "parameters": [ + {"name": "symbol"}, + {"name": "isin"}, + {"name": "limit", "default": 10}, + ], + "required_groups": [ + { + "combinator": "oneOf", + "alternatives": [["symbol"], ["isin"]], + "members": ["symbol", "isin", "limit"], + "required": False, + } + ], + } + _check_required_groups(cmd_spec, {"limit": 10, "index": "idx1"}) + _check_required_groups(cmd_spec, {"symbol": "A", "limit": 5}) + with pytest.raises( + ValueError, match=re.escape("Pass exactly one of: symbol | isin") + ): + _check_required_groups(cmd_spec, {"limit": 5}) + + +@pytest.mark.asyncio +async def test_dispatch_enforces_required_groups_without_a_request(): + def handler(request: httpx.Request) -> httpx.Response: + raise AssertionError(f"unexpected request to {request.url}") + + transport = httpx.MockTransport(handler) + client = httpx.AsyncClient(transport=transport, base_url="http://t") + d = HttpDispatcher( + "http://t", + client=client, + command_methods={"ticker": "get"}, + command_url_paths={"ticker": "/ticker"}, + spec_doc={ + "commands": { + "ticker": { + "url_path": "/ticker", + "parameters": [ + {"name": "symbol", "in": "query"}, + {"name": "symbols", "in": "query"}, + ], + "required_groups": [ + { + "combinator": "oneOf", + "alternatives": [["symbol"], ["symbols"]], + "members": ["symbol", "symbols"], + "required": True, + } + ], + } + } + }, + ) + try: + for params in ({}, {"symbol": "A", "symbols": "B"}): + resp = await d.dispatch(Request(command="ticker", params=params)) + assert not resp.ok + assert "Pass exactly one of: symbol | symbols" in resp.error.message + finally: + await d.aclose() diff --git a/cli/tests/test_dispatchers_openapi_schema.py b/cli/tests/test_dispatchers_openapi_schema.py index 62ec9973877..cc37885bfa0 100644 --- a/cli/tests/test_dispatchers_openapi_schema.py +++ b/cli/tests/test_dispatchers_openapi_schema.py @@ -2505,3 +2505,9 @@ def test_url_to_command_drops_placeholder_only_segments(): == "gridpoints.forecast" ) assert url_to_command("/points/{latitude},{longitude}", api_prefix="") == "points" + + +def test_merge_allof_ignores_a_required_flag_that_is_not_a_list(): + member = {"type": "object", "required": True, "properties": {"a": {}}} + merged = merge_allof({"allOf": [member], "required": True}) + assert merged == {"type": "object", "properties": {"a": {}}} diff --git a/cli/tests/test_dispatchers_overlay.py b/cli/tests/test_dispatchers_overlay.py new file mode 100644 index 00000000000..64a2abd9cf4 --- /dev/null +++ b/cli/tests/test_dispatchers_overlay.py @@ -0,0 +1,277 @@ +"""Tests for openbb_cli.dispatchers.overlay — OpenAPI Overlay application.""" + +from __future__ import annotations + +import pytest + +from openbb_cli.dispatchers.overlay import ( + apply_overlay, + load_overlay, + parse_target, + select, +) + + +def test_parse_target_dotted_names(): + assert parse_target("$.components.schemas.aggTrade") == [ + "components", + "schemas", + "aggTrade", + ] + + +def test_parse_target_quoted_names_indexes_and_wildcards(): + assert parse_target("$.paths['/api/v3/klines'].get") == [ + "paths", + "/api/v3/klines", + "get", + ] + assert parse_target('$["a.b"][0][*].*') == ["a.b", 0, None, None] + assert parse_target("$['it\\'s']") == ["it's"] + assert parse_target("$.a[-1]") == ["a", -1] + + +def test_parse_target_root_only(): + assert parse_target("$") == [] + + +@pytest.mark.parametrize( + "target", + [ + "components.schemas", + "$..schemas", + "$.a[?(@.x)]", + "$.a[0:2]", + "$['a','b']", + "$['unterminated", + "$.a.", + ], +) +def test_parse_target_rejects_unsupported_or_malformed(target): + with pytest.raises(ValueError): + parse_target(target) + + +def test_select_matches_numeric_keys_written_as_strings(): + doc = {"responses": {200: {"description": "ok"}}} + [(_, key, node)] = select(doc, parse_target("$.responses['200']")) + assert key == 200 + assert node == {"description": "ok"} + + +def test_select_wildcards_over_objects_and_arrays(): + doc = {"a": {"x": [1, 2], "y": [3]}} + nodes = [node for _, _, node in select(doc, parse_target("$.a.*[*]"))] + assert nodes == [1, 2, 3] + + +def test_select_returns_nothing_for_missing_paths(): + assert select({"a": {}}, parse_target("$.a.b.c")) == [] + assert select({"a": [1]}, parse_target("$.a[5]")) == [] + + +def _overlay(*actions): + return { + "overlay": "1.0.0", + "info": {"title": "t", "version": "1"}, + "actions": list(actions), + } + + +def test_apply_overlay_merges_update_without_mutating_input(): + openapi = { + "components": { + "schemas": { + "aggTrade": { + "properties": {"T": {"type": "boolean", "description": "Timestamp"}} + } + } + } + } + doc, unmatched = apply_overlay( + openapi, + _overlay( + { + "target": "$.components.schemas.aggTrade.properties.T", + "update": {"type": "integer", "format": "int64"}, + } + ), + ) + assert unmatched == [] + assert doc["components"]["schemas"]["aggTrade"]["properties"]["T"] == { + "type": "integer", + "description": "Timestamp", + "format": "int64", + } + assert openapi["components"]["schemas"]["aggTrade"]["properties"]["T"] == { + "type": "boolean", + "description": "Timestamp", + } + + +def test_apply_overlay_merges_integer_keys_into_string_keys(): + doc = {"responses": {"200": {"description": "ok"}}} + out, _ = apply_overlay( + doc, + {"actions": [{"target": "$.responses", "update": {200: {"x-row": True}}}]}, + ) + assert out["responses"] == {"200": {"description": "ok", "x-row": True}} + + +def test_apply_overlay_reads_yaml_integer_keys_as_strings(): + import json + + doc = {"responses": {200: {"description": "ok"}}} + out, _ = apply_overlay( + doc, + {"actions": [{"target": "$.responses", "update": {"404": {"x": 1}}}]}, + ) + assert out["responses"] == {"200": {"description": "ok"}, "404": {"x": 1}} + json.dumps(out, sort_keys=True) + + +def test_apply_overlay_treats_non_ascii_digit_keys_as_names(): + out, _ = apply_overlay( + {"x": {}}, {"actions": [{"target": "$.x", "update": {"²": 1, "--1": 2}}]} + ) + assert out["x"] == {"²": 1, "--1": 2} + with pytest.raises(ValueError, match="unsupported JSONPath syntax"): + parse_target("$.x[²]") + + +def test_apply_overlay_merges_nested_objects_and_replaces_other_values(): + doc, _ = apply_overlay( + {"a": {"b": {"keep": 1, "list": [1, 2]}}}, + _overlay({"target": "$.a", "update": {"b": {"list": [3], "new": True}}}), + ) + assert doc == {"a": {"b": {"keep": 1, "list": [3], "new": True}}} + + +def test_apply_overlay_appends_update_to_selected_array(): + doc, _ = apply_overlay( + {"tags": [{"name": "a"}]}, + _overlay({"target": "$.tags", "update": {"name": "b"}}), + ) + assert doc["tags"] == [{"name": "a"}, {"name": "b"}] + + +def test_apply_overlay_removes_selected_nodes(): + doc, _ = apply_overlay( + {"filters": {"properties": {"x": {}}, "required": ["x"], "type": "object"}}, + _overlay( + {"target": "$.filters.properties", "remove": True}, + {"target": "$.filters.required", "remove": True}, + {"target": "$.filters", "update": {"additionalProperties": True}}, + ), + ) + assert doc == {"filters": {"type": "object", "additionalProperties": True}} + + +def test_apply_overlay_removes_every_wildcard_array_match(): + doc, _ = apply_overlay( + {"a": [1, 2, 3], "b": [4]}, + _overlay({"target": "$.a[*]", "remove": True}), + ) + assert doc == {"a": [], "b": [4]} + + +def test_apply_overlay_reports_targets_that_match_nothing(): + doc, unmatched = apply_overlay( + {"a": 1}, _overlay({"target": "$.missing", "update": {"x": 1}}) + ) + assert doc == {"a": 1} + assert unmatched == ["$.missing"] + + +def test_apply_overlay_action_without_update_or_remove_is_a_no_op(): + doc, unmatched = apply_overlay({"a": {"b": 1}}, _overlay({"target": "$.a"})) + assert doc == {"a": {"b": 1}} + assert unmatched == [] + + +@pytest.mark.parametrize( + "action", + [ + {"update": {"x": 1}}, + {"target": 5, "update": {"x": 1}}, + {"target": "$.a", "update": {"x": 1}}, + {"target": "$.b", "update": "scalar"}, + {"target": "$", "remove": True}, + ], +) +def test_apply_overlay_rejects_invalid_actions(action): + with pytest.raises(ValueError): + apply_overlay({"a": 1, "b": {}}, _overlay(action)) + + +def test_load_overlay_reads_yaml(tmp_path): + path = tmp_path / "fix.overlay.yaml" + path.write_text( + "overlay: 1.0.0\n" + "info: {title: fix, version: '1'}\n" + "actions:\n" + " - target: $.info\n" + " update: {title: patched}\n" + ) + overlay = load_overlay(path) + assert overlay["actions"] == [{"target": "$.info", "update": {"title": "patched"}}] + + +def test_load_overlay_reads_json(tmp_path): + path = tmp_path / "fix.overlay.json" + path.write_text('{"overlay": "1.0.0", "actions": []}') + assert load_overlay(path)["actions"] == [] + + +def test_load_overlay_reads_keys_and_dates_as_json_would(tmp_path): + path = tmp_path / "fix.overlay.yaml" + path.write_text( + "overlay: 1.0.0\n" + "actions:\n" + " - target: $.paths['/x'].get.responses\n" + " update: {200: {description: ok, x-since: 2024-01-01}}\n" + ) + update = load_overlay(path)["actions"][0]["update"] + assert update == {"200": {"description": "ok", "x-since": "2024-01-01"}} + + +def test_load_overlay_reads_tab_indented_json(tmp_path): + path = tmp_path / "fix.overlay.json" + path.write_text('{\n\t"overlay": "1.0.0",\n\t"actions": []\n}') + assert load_overlay(path)["actions"] == [] + + +def test_load_overlay_reads_tab_indented_json_with_a_byte_order_mark(tmp_path): + path = tmp_path / "fix.overlay.json" + path.write_bytes(b'\xef\xbb\xbf{\n\t"overlay": "1.0.0",\n\t"actions": []\n}') + assert load_overlay(path)["actions"] == [] + + +def test_apply_overlay_reads_update_keys_as_strings(): + out, _ = apply_overlay( + {"responses": {"200": {}}}, + {"actions": [{"target": "$.responses", "update": {404: {"x": 1}}}]}, + ) + assert out["responses"] == {"200": {}, "404": {"x": 1}} + + +def test_load_overlay_reports_invalid_yaml_as_value_error(tmp_path): + path = tmp_path / "bad.yaml" + path.write_text("overlay: 1.0.0\nactions: [\n") + with pytest.raises(ValueError, match="not valid YAML or JSON"): + load_overlay(path) + + +@pytest.mark.parametrize( + "text", + [ + "openapi: 3.0.0\npaths: {}\n", + "overlay: 1.0.0\nactions: {}\n", + "- just\n- a list\n", + ], +) +def test_load_overlay_rejects_non_overlay_documents(tmp_path, text): + path = tmp_path / "bad.yaml" + path.write_text(text) + with pytest.raises(ValueError): + load_overlay(path) diff --git a/cli/tests/test_dispatchers_spec.py b/cli/tests/test_dispatchers_spec.py index 9cab8b2c067..6dcd710fde8 100644 --- a/cli/tests/test_dispatchers_spec.py +++ b/cli/tests/test_dispatchers_spec.py @@ -9,13 +9,17 @@ import pytest from openbb_cli.dispatchers.spec import ( SPEC_VERSION, SpecCommandError, + _explode_object_parameter, + _merge_overload_entries, _normalize_parameter, + _required_groups, build_command_spec, build_spec_document, command_parameters, load_spec, parse_command_argv, parser_from_command_spec, + unnamed_paths, write_spec, ) @@ -174,6 +178,35 @@ def test_build_spec_document_carries_metadata(): assert "/x" in doc["reference"]["paths"] +def test_build_spec_document_explicit_api_prefix_only_changes_naming(): + """Paths outside the prefix keep full names; the recorded prefix stays shared.""" + openapi = { + "paths": { + "/api/v3/klines": {"get": {"operationId": "k", "parameters": []}}, + "/api/v3/ticker/price": {"get": {"operationId": "p", "parameters": []}}, + "/sapi/v1/system/status": {"get": {"operationId": "s", "parameters": []}}, + } + } + doc = build_spec_document(openapi, base_url="http://h", api_prefix="/api/v3") + assert set(doc["commands"]) == {"klines", "ticker.price", "sapi.v1.system.status"} + assert doc["commands"]["klines"]["url_path"] == "/api/v3/klines" + assert doc["api_prefix"] == "" + assert doc["routers"]["ticker"] == "menu" + assert "/ticker/price" in doc["reference"]["paths"] + + +def test_build_spec_document_default_api_prefix_is_detected(): + openapi = { + "paths": { + "/api/v3/klines": {"get": {"operationId": "k", "parameters": []}}, + "/sapi/v1/system/status": {"get": {"operationId": "s", "parameters": []}}, + } + } + doc = build_spec_document(openapi, base_url="http://h") + assert set(doc["commands"]) == {"api.v3.klines", "sapi.v1.system.status"} + assert doc["api_prefix"] == "" + + def test_write_then_load_round_trip(tmp_path): openapi = {"paths": {"/api/v1/x": {"get": {"operationId": "x", "parameters": []}}}} doc = build_spec_document(openapi, base_url="http://h") @@ -675,6 +708,34 @@ def test_parse_command_argv_returns_command_and_params(): assert params == {"symbol": "AAPL"} +def test_parse_command_argv_leaves_omitted_boolean_group_members_unset(): + spec_doc = _spec_with( + { + "tickers": { + "url_path": "/tickers", + "method": "get", + "parameters": [ + {"name": "symbol", "type": "string"}, + {"name": "all", "type": "boolean"}, + {"name": "verbose", "type": "boolean"}, + ], + "required_groups": [ + { + "combinator": "oneOf", + "alternatives": [["symbol"], ["all"]], + "members": ["symbol", "all"], + "required": True, + } + ], + } + } + ) + _, params = parse_command_argv(spec_doc, ["tickers", "--symbol", "BTC"]) + assert params == {"symbol": "BTC", "verbose": False} + _, params = parse_command_argv(spec_doc, ["tickers", "--no-all"]) + assert params == {"all": False, "verbose": False} + + def test_parse_command_argv_empty_argv_raises(): with pytest.raises(SpecCommandError, match="missing command"): parse_command_argv(_spec_with({}), []) @@ -1588,3 +1649,734 @@ def test_description_stating_a_delimited_list_makes_the_param_an_array(): } ) assert arr["list_style"] == "multi" + + +def _selection_param(**overrides): + param = { + "name": "selection", + "in": "query", + "required": True, + "schema": { + "type": "object", + "properties": { + "symbol": {"type": "string", "example": "BNBUSDT"}, + "symbols": {"type": "string"}, + }, + "oneOf": [{"required": ["symbol"]}, {"required": ["symbols"]}], + }, + } + param.update(overrides) + return param + + +def test_explode_object_parameter_splits_properties_and_reads_groups(): + exploded, groups = _explode_object_parameter(_selection_param()) + assert [p["name"] for p in exploded] == ["symbol", "symbols"] + assert all(p["in"] == "query" and p["required"] is False for p in exploded) + assert exploded[0]["schema"] == {"type": "string", "example": "BNBUSDT"} + assert groups == [ + { + "combinator": "oneOf", + "alternatives": [["symbol"], ["symbols"]], + "members": ["symbol", "symbols"], + "required": True, + } + ] + + +def test_explode_object_parameter_required_properties_need_a_required_param(): + param = _selection_param() + param["schema"] = {**param["schema"], "required": ["symbol"]} + exploded, _ = _explode_object_parameter(param) + assert [p["required"] for p in exploded] == [True, False] + exploded, groups = _explode_object_parameter({**param, "required": False}) + assert [p["required"] for p in exploded] == [False, False] + assert groups[0]["required"] is False + + +def test_explode_object_parameter_reads_per_property_examples(): + exploded, _ = _explode_object_parameter( + _selection_param(example={"symbols": '["A"]'}) + ) + assert "example" not in exploded[0] + assert exploded[1]["example"] == '["A"]' + + +def test_explode_object_parameter_merges_allof_members(): + param = _selection_param( + schema={ + "allOf": [ + {"type": "object", "properties": {"a": {"type": "string"}}}, + {"type": "object", "properties": {"b": {"type": "integer"}}}, + ] + } + ) + exploded, groups = _explode_object_parameter(param) + assert [p["name"] for p in exploded] == ["a", "b"] + assert groups == [] + + +@pytest.mark.parametrize( + "overrides", + [ + {"in": "path"}, + {"style": "deepObject"}, + {"explode": False}, + {"schema": {"type": "string"}}, + {"schema": {"type": "object", "additionalProperties": True}}, + {"schema": {"type": "array", "properties": {"a": {}}}}, + {"schema": None}, + ], +) +def test_explode_object_parameter_leaves_other_parameters_alone(overrides): + assert _explode_object_parameter(_selection_param(**overrides)) is None + + +def test_required_groups_reads_one_of_and_any_of(): + schema = { + "properties": {"a": {}, "b": {}, "c": {}}, + "oneOf": [{"required": ["a"]}, {"required": ["b", "c"], "title": "both"}], + "anyOf": [{"required": ["c"]}, {"required": ["a"]}], + } + groups = _required_groups(schema, required=False) + assert [(g["combinator"], g["alternatives"]) for g in groups] == [ + ("oneOf", [["a"], ["b", "c"]]), + ("anyOf", [["c"], ["a"]]), + ] + assert all(g["required"] is False for g in groups) + + +@pytest.mark.parametrize( + "alternatives", + [ + [{"required": ["a"]}, {"required": ["a"], "not": {"required": ["b"]}}], + [{"required": ["a"]}, {"required": ["missing"]}], + [{"required": ["a"]}, {"required": []}], + [{"required": ["a"]}, "a"], + [], + ], +) +def test_required_groups_skips_combinators_it_cannot_enforce(alternatives): + schema = {"properties": {"a": {}, "b": {}}, "oneOf": alternatives} + assert _required_groups(schema, required=True) == [] + + +def _exploded_openapi(extra_params=None): + return { + "openapi": "3.0.2", + "paths": { + "/api/v3/ticker": { + "get": { + "parameters": [ + { + "name": "windowSize", + "in": "query", + "schema": {"type": "string"}, + }, + *(extra_params or []), + _selection_param(), + ], + "responses": {"200": {"description": "ok"}}, + } + } + }, + } + + +def test_build_command_spec_expands_object_param_and_records_groups(): + cmd = build_command_spec(_exploded_openapi(), api_prefix="/api/v3")["ticker"] + assert [p["name"] for p in cmd["parameters"]] == ["windowSize", "symbol", "symbols"] + symbol = cmd["parameters"][1] + assert symbol["required"] is False + assert symbol["example"] == "BNBUSDT" + assert cmd["required_groups"][0]["alternatives"] == [["symbol"], ["symbols"]] + assert list(cmd)[:5] == [ + "url_path", + "method", + "description", + "parameters", + "required_groups", + ] + + +def test_build_command_spec_keeps_explicit_param_over_exploded_property(): + explicit = {"name": "symbol", "in": "query", "schema": {"type": "integer"}} + cmd = build_command_spec(_exploded_openapi([explicit]), api_prefix="/api/v3")[ + "ticker" + ] + names = [p["name"] for p in cmd["parameters"]] + assert names == ["windowSize", "symbol", "symbols"] + assert cmd["parameters"][1]["type"] == "integer" + + +def test_build_command_spec_drops_groups_naming_filtered_params(): + openapi = _exploded_openapi() + param = openapi["paths"]["/api/v3/ticker"]["get"]["parameters"][1] + param["schema"]["properties"]["chart"] = param["schema"]["properties"].pop( + "symbols" + ) + param["schema"]["oneOf"] = [{"required": ["symbol"]}, {"required": ["chart"]}] + cmd = build_command_spec(openapi, api_prefix="/api/v3")["ticker"] + assert [p["name"] for p in cmd["parameters"]] == ["windowSize", "symbol"] + assert "required_groups" not in cmd + + +def test_build_command_spec_omits_groups_key_without_object_params(): + openapi = _exploded_openapi() + openapi["paths"]["/api/v3/ticker"]["get"]["parameters"].pop() + assert ( + "required_groups" + not in build_command_spec(openapi, api_prefix="/api/v3")["ticker"] + ) + + +def test_merge_overload_entries_relaxes_groups_missing_from_a_variant(): + group = { + "combinator": "oneOf", + "alternatives": [["symbol"], ["symbols"]], + "members": ["symbol", "symbols"], + "required": True, + } + entry = {"url_path": "/x", "method": "get", "parameters": []} + merged = _merge_overload_entries( + [{**entry, "required_groups": [group]}, {**entry, "url_path": "/x/{id}"}] + ) + assert merged["required_groups"] == [{**group, "required": False}] + both = _merge_overload_entries( + [ + {**entry, "required_groups": [group]}, + {**entry, "url_path": "/x/{id}", "required_groups": [dict(group)]}, + ] + ) + assert both["required_groups"] == [group] + assert "required_groups" not in _merge_overload_entries( + [entry, {**entry, "url_path": "/x/{id}"}] + ) + + +def test_build_command_spec_explicit_param_wins_in_either_order(): + explicit = {"name": "symbol", "in": "query", "schema": {"type": "integer"}} + for order in ("explicit_first", "object_first"): + openapi = _exploded_openapi() + params = openapi["paths"]["/api/v3/ticker"]["get"]["parameters"] + if order == "explicit_first": + params.insert(1, explicit) + else: + params.append(explicit) + cmd = build_command_spec(openapi, api_prefix="/api/v3")["ticker"] + names = [p["name"] for p in cmd["parameters"]] + assert sorted(names) == ["symbol", "symbols", "windowSize"], order + symbol = next(p for p in cmd["parameters"] if p["name"] == "symbol") + assert symbol["type"] == "integer", order + assert "required_groups" not in cmd, order + + +def test_build_command_spec_path_item_object_param_yields_to_operation_param(): + openapi = _exploded_openapi() + path = openapi["paths"]["/api/v3/ticker"] + path["parameters"] = [path["get"]["parameters"].pop()] + path["get"]["parameters"].append( + { + "name": "symbol", + "in": "query", + "required": True, + "schema": {"type": "integer"}, + } + ) + cmd = build_command_spec(openapi, api_prefix="/api/v3")["ticker"] + assert sorted(p["name"] for p in cmd["parameters"]) == [ + "symbol", + "symbols", + "windowSize", + ] + assert next(p for p in cmd["parameters"] if p["name"] == "symbol")["required"] + + +def test_build_command_spec_drops_skipped_names_from_group_members(): + openapi = _exploded_openapi( + [{"name": "limit", "in": "query", "schema": {"type": "integer"}}] + ) + selection = openapi["paths"]["/api/v3/ticker"]["get"]["parameters"][-1] + selection["schema"]["properties"]["limit"] = {"type": "integer"} + cmd = build_command_spec(openapi, api_prefix="/api/v3")["ticker"] + assert cmd["required_groups"][0]["members"] == ["symbol", "symbols"] + + +def test_explode_object_parameter_drops_defaults_the_groups_must_see(): + param = _selection_param() + props = param["schema"]["properties"] + props["symbol"]["default"] = "BTCUSDT" + props["limit"] = {"type": "integer", "default": 100} + exploded, _ = _explode_object_parameter(param) + by_name = {p["name"]: p["schema"] for p in exploded} + assert "default" not in by_name["symbol"] + assert by_name["limit"]["default"] == 100 + exploded, _ = _explode_object_parameter({**param, "required": False}) + assert all("default" not in p["schema"] for p in exploded) + + +def test_explode_object_parameter_keeps_defaults_without_groups(): + param = _selection_param( + schema={ + "type": "object", + "properties": {"limit": {"type": "integer", "default": 100}}, + }, + required=False, + ) + exploded, groups = _explode_object_parameter(param) + assert groups == [] + assert exploded[0]["schema"]["default"] == 100 + + +def test_explode_object_parameter_reads_examples_map_and_schema_examples(): + exploded, _ = _explode_object_parameter( + _selection_param(examples={"one": {"value": {"symbols": '["A"]'}}}) + ) + assert exploded[1]["example"] == '["A"]' + param = _selection_param() + param["schema"] = {**param["schema"], "examples": [{"symbol": "ETHUSDT"}]} + exploded, _ = _explode_object_parameter(param) + assert exploded[0]["example"] == "ETHUSDT" + + +def test_explode_optional_object_records_its_required_list_as_a_group(): + param = _selection_param( + required=False, + schema={ + "type": "object", + "properties": { + "startDate": {"type": "string"}, + "endDate": {"type": "string"}, + }, + "required": ["startDate", "endDate"], + }, + ) + exploded, groups = _explode_object_parameter(param) + assert [p["required"] for p in exploded] == [False, False] + assert groups == [ + { + "combinator": "anyOf", + "alternatives": [["startDate", "endDate"]], + "members": ["startDate", "endDate"], + "required": False, + } + ] + + +def _json_array_openapi(param): + return { + "openapi": "3.0.2", + "paths": { + "/x": { + "get": { + "parameters": [param], + "responses": {"200": {"description": "ok"}}, + } + } + }, + "components": { + "schemas": {"Symbols": {"type": "array", "items": {"type": "string"}}} + }, + } + + +def test_content_json_array_param_is_a_json_list(): + param = { + "name": "symbols", + "in": "query", + "content": { + "application/json": { + "schema": {"$ref": "#/components/schemas/Symbols"}, + "example": ["BTCUSDT", "ETHUSDT"], + } + }, + } + [normalized] = build_command_spec(_json_array_openapi(param), api_prefix="")["x"][ + "parameters" + ] + assert normalized["is_list"] is True + assert normalized["list_style"] == "json" + assert normalized["type"] == "string" + assert normalized["example"] == ["BTCUSDT", "ETHUSDT"] + + +def test_content_media_type_json_array_schema_is_a_json_list(): + param = { + "name": "symbols", + "in": "query", + "schema": { + "type": "string", + "contentMediaType": "application/json", + "contentSchema": {"type": "array", "items": {"type": "integer"}}, + }, + } + normalized = _normalize_parameter(param) + assert normalized["is_list"] is True + assert normalized["list_style"] == "json" + assert normalized["type"] == "integer" + + +def test_json_content_that_is_not_an_array_is_left_alone(): + param = { + "name": "filter", + "in": "query", + "content": {"application/json": {"schema": {"type": "object"}}}, + } + normalized = _normalize_parameter(param) + assert normalized["is_list"] is False + assert "list_style" not in normalized + + +def _sigmets_openapi(): + def op(*params): + return { + "get": { + "parameters": list(params), + "responses": {"200": {"description": "ok"}}, + } + } + + def path(name): + return { + "name": name, + "in": "path", + "required": True, + "schema": {"type": "string"}, + } + + def query(name): + return {"name": name, "in": "query", "schema": {"type": "string"}} + + return { + "openapi": "3.0.2", + "paths": { + "/aviation/sigmets": op(query("atsu"), query("date"), query("start")), + "/aviation/sigmets/{atsu}": op(path("atsu")), + "/aviation/sigmets/{atsu}/{date}": op(path("atsu"), path("date")), + "/aviation/cwsus/{cwsuId}/cwas": op(path("cwsuId")), + "/aviation/cwsus/{cwsuId}/cwas/{date}/{sequence}": op( + path("cwsuId"), path("date"), path("sequence") + ), + }, + } + + +def test_merge_records_each_templates_query_params(): + commands = build_command_spec(_sigmets_openapi(), api_prefix="") + assert commands["aviation.sigmets"]["template_query_params"] == { + "/aviation/sigmets/{atsu}/{date}": [], + "/aviation/sigmets/{atsu}": [], + "/aviation/sigmets": ["atsu", "date", "start"], + } + assert commands["aviation.cwsus.cwas"]["template_query_params"] == { + "/aviation/cwsus/{cwsuId}/cwas/{date}/{sequence}": [], + "/aviation/cwsus/{cwsuId}/cwas": [], + } + assert ( + "template_query_params" + not in build_command_spec( + _json_array_openapi( + {"name": "q", "in": "query", "schema": {"type": "string"}} + ), + api_prefix="", + )["x"] + ) + + +def test_merge_requires_a_param_only_when_every_variant_requires_it(): + commands = build_command_spec(_sigmets_openapi(), api_prefix="") + required = { + p["name"]: p["required"] for p in commands["aviation.sigmets"]["parameters"] + } + assert required["atsu"] is False + cwas = { + p["name"]: p["required"] for p in commands["aviation.cwsus.cwas"]["parameters"] + } + assert cwas == {"cwsuId": True, "date": False, "sequence": False} + + +def test_json_array_detection_only_applies_to_query_params(): + param = { + "name": "ids", + "in": "path", + "required": True, + "content": {"application/json": {"schema": {"type": "array", "items": {}}}}, + } + normalized = _normalize_parameter(param) + assert normalized["is_list"] is False + assert "list_style" not in normalized + + +def test_exploded_group_member_gets_no_synthesized_json_default(): + param = _selection_param( + required=False, + schema={ + "type": "object", + "required": ["symbol"], + "properties": { + "symbol": {"type": "string"}, + "format": {"type": "string", "enum": ["json", "xml", "csv"]}, + }, + }, + ) + openapi = _exploded_openapi() + openapi["paths"]["/api/v3/ticker"]["get"]["parameters"][-1] = param + cmd = build_command_spec(openapi, api_prefix="/api/v3")["ticker"] + fmt = next(p for p in cmd["parameters"] if p["name"] == "format") + assert fmt["default"] is None + + +def _mixed_method_openapi(): + pet = {"type": "object", "properties": {"id": {"type": "integer"}}} + pid = { + "name": "petId", + "in": "path", + "required": True, + "schema": {"type": "integer"}, + } + ok = {"200": {"description": "ok"}} + return { + "openapi": "3.0.2", + "paths": { + "/pet": { + "post": { + "requestBody": {"content": {"application/json": {"schema": pet}}}, + "responses": ok, + } + }, + "/pet/{petId}": {"get": {"parameters": [pid], "responses": ok}}, + "/pets": {"get": {"responses": ok}}, + "/pets/{petId}": {"get": {"parameters": [pid], "responses": ok}}, + }, + } + + +def test_build_command_spec_does_not_merge_across_http_methods(): + commands = build_command_spec(_mixed_method_openapi(), api_prefix="") + assert commands["pet"]["method"] == "get" + assert commands["pet"]["url_path"] == "/pet/{petId}" + assert "url_templates" not in commands["pet"] + assert commands["pet_post"]["method"] == "post" + assert commands["pet_post"]["url_path"] == "/pet" + assert commands["pets"]["url_templates"] == ["/pets/{petId}", "/pets"] + + +def test_split_command_is_listed_in_routers_and_reference(): + doc = build_spec_document(_mixed_method_openapi(), base_url="http://h") + assert doc["routers"]["pet_post"] == "command" + assert "/pet_post" in doc["reference"]["paths"] + + +def test_build_command_spec_splits_get_and_post_on_one_path(): + ok = {"200": {"description": "ok"}} + openapi = { + "paths": {"/orders": {"get": {"responses": ok}, "post": {"responses": ok}}} + } + commands = build_command_spec(openapi, api_prefix="") + assert commands["orders"]["method"] == "get" + assert commands["orders_post"]["method"] == "post" + assert commands["orders_post"]["url_path"] == "/orders" + + +def test_split_post_name_skips_a_name_another_url_takes(): + ok = {"200": {"description": "ok"}} + order_id = {"name": "id", "in": "path", "required": True, "schema": {}} + since = {"name": "since", "in": "query", "required": True, "schema": {}} + openapi = { + "paths": { + "/orders/{id}": {"get": {"parameters": [order_id], "responses": ok}}, + "/orders": {"post": {"responses": ok}}, + "/orders_post": {"get": {"parameters": [since], "responses": ok}}, + } + } + commands = build_command_spec(openapi, api_prefix="") + assert commands["orders_post"]["method"] == "get" + assert commands["orders_post"]["url_path"] == "/orders_post" + assert commands["orders_post"]["parameters"][0]["required"] is True + assert commands["orders_post2"]["method"] == "post" + assert commands["orders_post2"]["url_path"] == "/orders" + + +def test_split_get_command_reference_keeps_the_get_description(): + openapi = _mixed_method_openapi() + openapi["paths"]["/pet"]["post"]["description"] = "Add a pet." + openapi["paths"]["/pet/{petId}"]["get"]["description"] = "Find a pet by id." + doc = build_spec_document(openapi, base_url="http://h") + assert doc["reference"]["paths"]["/pet"]["description"] == "Find a pet by id." + assert doc["reference"]["paths"]["/pet_post"]["description"] == "Add a pet." + + +def test_unnamed_paths_lists_paths_the_prefix_strips_to_nothing(): + ok = {"get": {"responses": {"200": {"description": "ok"}}}} + openapi = { + "paths": { + "/v1/accounts": ok, + "/v1/accounts/{id}": ok, + "/v1/accounts/{id}/orders": ok, + } + } + assert unnamed_paths(openapi, api_prefix="/v1/accounts") == [ + "/v1/accounts", + "/v1/accounts/{id}", + ] + assert unnamed_paths(openapi, api_prefix="/v1") == [] + + +def test_explode_object_parameter_ignores_a_required_flag_that_is_not_a_list(): + param = { + "name": "filter", + "in": "query", + "schema": { + "type": "object", + "required": True, + "properties": {"a": {"type": "string"}}, + }, + } + exploded, groups = _explode_object_parameter(param) + assert [(p["name"], p["required"]) for p in exploded] == [("a", False)] + assert groups == [] + + +def test_post_operations_with_different_bodies_stay_separate_commands(): + ok = {"200": {"description": "ok"}} + pet = {"type": "object", "properties": {"name": {"type": "string"}}} + body = {"requestBody": {"content": {"application/json": {"schema": pet}}}} + pid = {"name": "petId", "in": "path", "required": True, "schema": {}} + status = {"name": "status", "in": "query", "schema": {}} + openapi = { + "paths": { + "/pet": {"post": {**body, "responses": ok}}, + "/pet/{petId}": { + "get": {"parameters": [pid], "responses": ok}, + "post": {"parameters": [pid, status], "responses": ok}, + }, + "/pets": {"post": {**body, "responses": ok}}, + "/pets/{petId}": {"post": {**body, "parameters": [pid], "responses": ok}}, + } + } + commands = build_command_spec(openapi, api_prefix="") + assert commands["pet"]["url_path"] == "/pet/{petId}" + assert commands["pet_post"]["url_path"] == "/pet" + assert commands["pet_post"]["request_body_schema"] is not None + assert commands["pet_post2"]["url_path"] == "/pet/{petId}" + assert commands["pet_post2"]["request_body_schema"] is None + assert commands["pets"]["url_templates"] == ["/pets/{petId}", "/pets"] + + +def test_get_command_reference_ignores_post_text_when_get_has_none(): + openapi = _mixed_method_openapi() + openapi["paths"]["/pet"]["post"]["description"] = "Add a pet." + doc = build_spec_document(openapi, base_url="http://h") + assert doc["reference"]["paths"]["/pet"]["description"] == "" + assert doc["reference"]["paths"]["/pet_post"]["description"] == "Add a pet." + + +def test_unnamed_paths_leaves_out_paths_that_have_no_name_anyway(): + ok = {"get": {"responses": {"200": {"description": "ok"}}}} + openapi = {"paths": {"/": ok, "/{id}": ok, "/v1": ok, "/v1/x": ok}} + assert unnamed_paths(openapi, api_prefix="/v1") == ["/v1"] + + +def test_explode_object_parameter_ignores_a_non_list_required_inside_allof(): + member = {"type": "object", "required": True, "properties": {"a": {}}} + param = {"name": "filter", "in": "query", "schema": {"allOf": [member]}} + exploded, groups = _explode_object_parameter(param) + assert [p["name"] for p in exploded] == ["a"] + assert groups == [] + + +def test_post_bodies_that_differ_only_in_docs_still_merge(): + import datetime + + ok = {"200": {"description": "ok"}} + + def body(title, example): + schema = { + "title": title, + "type": "object", + "required": ["b", "a"] if title == "One" else ["a", "b"], + "properties": {"a": {"type": "string", "example": example}, "b": {}}, + } + return {"requestBody": {"content": {"application/json": {"schema": schema}}}} + + pid = {"name": "id", "in": "path", "required": True, "schema": {}} + openapi = { + "paths": { + "/x": { + "post": {**body("One", datetime.date(2024, 1, 31)), "responses": ok} + }, + "/x/{id}": { + "post": {**body("Two", "b"), "parameters": [pid], "responses": ok} + }, + } + } + commands = build_command_spec(openapi, api_prefix="") + assert list(commands) == ["x"] + assert commands["x"]["url_templates"] == ["/x/{id}", "/x"] + + +def test_split_post_commands_each_keep_their_own_reference_text(): + ok = {"200": {"description": "ok"}} + pet = {"type": "object", "properties": {"name": {"type": "string"}}} + pid = {"name": "petId", "in": "path", "required": True, "schema": {}} + openapi = { + "paths": { + "/pet": { + "post": { + "requestBody": {"content": {"application/json": {"schema": pet}}}, + "responses": ok, + } + }, + "/pet/{petId}": { + "post": { + "description": "Updates a pet by id.", + "parameters": [pid], + "responses": ok, + } + }, + } + } + doc = build_spec_document(openapi, base_url="http://h") + assert doc["commands"]["pet"]["url_path"] == "/pet" + assert doc["reference"]["paths"]["/pet"]["description"] == "" + assert doc["reference"]["paths"]["/pet_post"]["description"] == ( + "Updates a pet by id." + ) + + +def test_get_command_with_a_post_sibling_keeps_its_base_url_reference_text(): + ok = {"200": {"description": "ok"}} + pid = {"name": "petId", "in": "path", "required": True, "schema": {}} + openapi = { + "paths": { + "/pets": { + "get": {"description": "List all pets.", "responses": ok}, + "post": {"description": "Create a pet.", "responses": ok}, + }, + "/pets/{petId}": { + "get": { + "description": "Info for a pet.", + "parameters": [pid], + "responses": ok, + } + }, + } + } + doc = build_spec_document(openapi, base_url="http://h") + assert doc["reference"]["paths"]["/pets"]["description"] == "List all pets." + assert doc["reference"]["paths"]["/pets_post"]["description"] == "Create a pet." + + +def test_merge_keeps_each_urls_response_schema_when_it_differs(): + openapi = _mixed_method_openapi() + item = {"type": "object", "properties": {"id": {"type": "integer"}}} + listing = {"type": "array", "items": item} + + def content(schema): + return {"200": {"content": {"application/json": {"schema": schema}}}} + + openapi["paths"]["/pets"]["get"]["responses"] = content(listing) + openapi["paths"]["/pets/{petId}"]["get"]["responses"] = content(item) + pets = build_command_spec(openapi, api_prefix="")["pets"] + assert pets["response_schema"] == listing + assert pets["template_response_schemas"] == {"/pets/{petId}": item} diff --git a/cli/tests/test_dispatchers_unpack.py b/cli/tests/test_dispatchers_unpack.py index f708bafc3a7..4443ee3f456 100644 --- a/cli/tests/test_dispatchers_unpack.py +++ b/cli/tests/test_dispatchers_unpack.py @@ -4,7 +4,13 @@ from __future__ import annotations import pytest -from openbb_cli.dispatchers._unpack import safe_json_loads, unpack_response +from openbb_cli.dispatchers._unpack import ( + choose_url_template, + encode_query, + json_array, + safe_json_loads, + unpack_response, +) # --- list payloads --- @@ -27,6 +33,33 @@ def test_unpack_response_keeps_multi_dict_list_as_rows(): assert metadata == {} +def test_unpack_response_tuples_hint_keeps_each_inner_array_as_one_row(): + rows, metadata = unpack_response([[1, "a"], [2, "b"]], kind="tuples") + assert rows == [{"value": [1, "a"]}, {"value": [2, "b"]}] + assert metadata == {} + + +def test_unpack_response_tuples_hint_does_not_flatten_a_single_row(): + rows, metadata = unpack_response([[1, "a", "b"]], kind="tuples") + assert rows == [{"value": [1, "a", "b"]}] + assert metadata == {} + + +def test_unpack_response_tuples_hint_falls_back_when_payload_does_not_fit(): + assert unpack_response([{"a": 1}], kind="tuples") == unpack_response([{"a": 1}]) + assert unpack_response({"a": [1]}, kind="tuples") == unpack_response({"a": [1]}) + + +def test_unpack_response_records_hint_keeps_a_single_record_whole(): + record = {"orderListId": 1, "orders": [{"symbol": "BTCUSDT", "orderId": 2}]} + assert unpack_response([record], kind="records") == ([record], {}) + + +def test_unpack_response_records_hint_falls_back_when_payload_does_not_fit(): + payload = {"a": [{"b": 1}]} + assert unpack_response(payload, kind="records") == unpack_response(payload) + + def test_unpack_response_wraps_array_of_scalars_as_value_rows(): rows, metadata = unpack_response(["2026-01-01", "2026-01-02"]) assert rows == [{"value": "2026-01-01"}, {"value": "2026-01-02"}] @@ -137,3 +170,151 @@ def test_safe_json_loads_propagates_unfixable_errors(): the sanitization fallback — the fallback isn't a magical rescue.""" with pytest.raises(ValueError): safe_json_loads('{"a": ,}') + + +def test_encode_query_encodes_reserved_characters(): + assert encode_query({"timeZone": "+8"}) == "timeZone=%2B8" + assert encode_query({"q": "a b&c=d#e%"}) == "q=a%20b%26c%3Dd%23e%25" + assert ( + encode_query({"symbols": '["BTCUSDT","ETHUSDT"]'}) + == "symbols=%5B%22BTCUSDT%22,%22ETHUSDT%22%5D" + ) + + +def test_encode_query_keeps_delimiters_literal_and_matches_old_shape(): + assert encode_query({"ids": "a,b", "at": "12:30", "path": "a/b"}) == ( + "ids=a,b&at=12:30&path=a/b" + ) + assert encode_query({"a": ["x", "y"], "b": None, "c": True, "d": 5}) == ( + "a=x&a=y&c=true&d=5" + ) + assert encode_query({}) == "" + assert encode_query({"$where": "x > 1"}) == "$where=x%20%3E%201" + + +def test_json_array_from_comma_list_or_json_string(): + assert json_array("BTCUSDT, ETHUSDT,") == '["BTCUSDT","ETHUSDT"]' + assert json_array('["BTCUSDT", "ETHUSDT"]') == '["BTCUSDT","ETHUSDT"]' + assert json_array("BTCUSDT") == '["BTCUSDT"]' + assert json_array("[not json") == '["[not json"]' + + +_SIGMETS = ( + ("/sigmets/{atsu}/{date}/{time}", ("atsu", "date", "time"), ()), + ("/sigmets/{atsu}/{date}", ("atsu", "date"), ()), + ("/sigmets/{atsu}", ("atsu",), ()), + ("/sigmets", (), ("date", "atsu", "start")), +) +_NO_VALUES = {"atsu": None, "date": None, "time": None} + + +def test_choose_url_template_picks_most_specific_fit(): + assert choose_url_template( + _SIGMETS, {**_NO_VALUES, "atsu": "KKCI", "date": "2026-10-18"} + ) == ("/sigmets/KKCI/2026-10-18", ["atsu", "date"], []) + assert choose_url_template(_SIGMETS, _NO_VALUES) == ( + "/sigmets", + [], + ["date", "atsu", "start"], + ) + + +def test_choose_url_template_lets_a_template_take_path_names_as_query(): + path, used, query_names = choose_url_template( + _SIGMETS, {**_NO_VALUES, "date": "2026-10-18"} + ) + assert (path, used) == ("/sigmets", []) + assert "date" in query_names + + +def test_choose_url_template_rejects_values_that_form_no_url(): + with pytest.raises(ValueError) as exc: + choose_url_template( + _SIGMETS, {**_NO_VALUES, "time": "0000"}, {"atsu": "atsu_id"} + ) + message = str(exc.value) + assert "Path parameters (time) do not form a URL" in message + assert "atsu_id + date + time | atsu_id + date | atsu_id | none" in message + + +def test_choose_url_template_treats_empty_string_as_not_passed(): + values = {**_NO_VALUES, "atsu": "K", "date": ""} + assert choose_url_template(_SIGMETS, values)[0] == "/sigmets/K" + + +def test_choose_url_template_handles_sets_that_do_not_nest(): + member = ( + ("/member/{stateCode}/{district}", ("stateCode", "district"), ()), + ("/member/{bioguideId}", ("bioguideId",), ()), + ("/member/{stateCode}", ("stateCode",), ()), + ("/member", (), ()), + ) + values = {"stateCode": None, "district": None, "bioguideId": None} + assert choose_url_template(member, {**values, "stateCode": "AZ"})[0] == "/member/AZ" + with pytest.raises(ValueError): + choose_url_template(member, {**values, "stateCode": "AZ", "bioguideId": "S1"}) + with pytest.raises(ValueError): + choose_url_template(member, {**values, "district": 7}) + + +_REPORTS = ( + ("/reports/{id}.{format}", ("id", "format"), ()), + ("/reports", (), ("year",)), +) + + +def test_choose_url_template_default_never_picks_or_blocks_a_url(): + defaults = {"format": "json"} + assert ( + choose_url_template(_REPORTS, {"id": None, "format": "json"}, None, defaults)[0] + == "/reports" + ) + rates = (("/rates/{fmt}", ("fmt",), ()), ("/rates", (), ())) + assert choose_url_template(rates, {"fmt": "json"}, None, {"fmt": "json"})[0] == ( + "/rates" + ) + assert choose_url_template(rates, {"fmt": "xml"}, None, {"fmt": "json"})[0] == ( + "/rates/xml" + ) + flags = (("/v/{n}/{flag}", ("n", "flag"), ()), ("/v", (), ("q",))) + assert ( + choose_url_template(flags, {"n": None, "flag": False}, None, {"flag": False})[0] + == "/v" + ) + + +def test_choose_url_template_default_completes_a_url_the_caller_picked(): + assert choose_url_template( + _REPORTS, {"id": 5, "format": "json"}, None, {"format": "json"} + )[:2] == ("/reports/5.json", ["id", "format"]) + + +def test_choose_url_template_default_shared_by_every_url_fills_the_shortest(): + asof = ( + ("/asof/{holding}/{date}.{format}", ("holding", "date", "format"), ()), + ("/summary.{format}", ("format",), ()), + ) + values = {"holding": None, "date": None, "format": "json"} + assert choose_url_template(asof, values, None, {"format": "json"})[0] == ( + "/summary.json" + ) + + +def test_json_array_converts_comma_items_to_the_item_type(): + assert json_array("1, 2", "integer") == "[1,2]" + assert json_array("1.5,2", "number") == "[1.5,2.0]" + assert json_array("true,False", "boolean") == "[true,false]" + assert json_array("[1, 2]", "string") == "[1,2]" + assert json_array(" ") is None + assert json_array("") is None + + +def test_encode_query_sends_booleans_lowercase(): + assert encode_query({"active": True, "flags": [True, False]}) == ( + "active=true&flags=true&flags=false" + ) + + +def test_choose_url_template_fills_boolean_path_values_lowercase(): + templates = (("/v/{flag}", ("flag",), ()), ("/v", (), ())) + assert choose_url_template(templates, {"flag": True})[0] == "/v/true" diff --git a/openbb_platform/core/openbb/assets/reference.json b/openbb_platform/core/openbb/assets/reference.json index 292b7157e3a..5945affb392 100644 --- a/openbb_platform/core/openbb/assets/reference.json +++ b/openbb_platform/core/openbb/assets/reference.json @@ -1,15 +1,298495 @@ { - "openbb": "2.0.0core", + "openbb": "2.0.1core", "info": { "title": "OpenBB Platform (Python)", "description": "Investment research for everyone, anywhere.", - "core": "2.0.0", + "core": "2.0.1", "extensions": { - "openbb_core_extension": [], - "openbb_provider_extension": [], - "openbb_obbject_extension": [] + "openbb_core_extension": [ + "bls@2.0.0", + "cboe@2.0.0", + "cftc@2.0.0", + "deribit@2.0.0", + "ecb@2.0.0", + "econometrics@2.0.0", + "eia@2.0.0", + "famafrench@2.0.0", + "federal_reserve@2.0.0", + "finra@2.0.0", + "fred@2.0.0", + "imf@3.0.0", + "jodi@2.0.0", + "nasdaq@2.0.0", + "news@2.0.0", + "oecd@2.0.0", + "quantitative@2.0.0", + "sec@2.0.0", + "technical@2.0.1", + "tmx@2.0.0", + "uscongress@2.0.0", + "usda@2.0.0", + "ustreasury@2.0.0", + "yfinance@2.0.0" + ], + "openbb_provider_extension": [ + "bls@2.0.0", + "cboe@2.0.0", + "cftc@2.0.0", + "congress_gov@2.0.0", + "deribit@2.0.0", + "ecb@2.0.0", + "famafrench@2.0.0", + "federal_reserve@2.0.0", + "finra@2.0.0", + "fred@2.0.0", + "imf@3.0.0", + "jodi@2.0.0", + "nasdaq@2.0.0", + "oecd@2.0.0", + "sec@2.0.0", + "tmx@2.0.0", + "us_eia@2.0.0", + "us_treasury@2.0.0", + "usda@2.0.0", + "yfinance@2.0.0" + ], + "openbb_obbject_extension": [ + "openbb_charting@4.0.0" + ] } }, - "paths": {}, - "routers": {} + "paths": { + "/bls/cpi/t1_expenditure_category": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 1 \u2014 CPI-U U.S. city average, by expenditure category.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U expenditure category table.\nobb.bls.cpi.t1_expenditure_category(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable1", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Weight as a percent of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "index_value", + "type": "float | None", + "description": "NSA CPI index at the latest reference month (date).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value", + "cellDataType": "number" + } + } + }, + { + "name": "index_value_prior_month", + "type": "float | None", + "description": "NSA CPI index one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value (Prior Month)", + "cellDataType": "number" + } + } + }, + { + "name": "index_value_year_ago", + "type": "float | None", + "description": "NSA CPI index twelve months before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value (Year Ago)", + "cellDataType": "number" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_nsa", + "type": "float | None", + "description": "One-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa", + "type": "float | None", + "description": "One-month SA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa_prior", + "type": "float | None", + "description": "One-month SA percent change ending one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA (Prior Month)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa_two_back", + "type": "float | None", + "description": "One-month SA percent change ending two months before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA (Two Months Back)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable1", + "openapi_extra": { + "model": "BlsCpiNrTable1" + } + }, + "/bls/cpi/t2_detailed_expenditure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 2 \u2014 CPI-U U.S. city average, by detailed expenditure category.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U detailed expenditure category table.\nobb.bls.cpi.t2_detailed_expenditure(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable2", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Weight as a percent of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_nsa", + "type": "float | None", + "description": "One-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa", + "type": "float | None", + "description": "One-month SA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa_prior", + "type": "float | None", + "description": "One-month SA percent change ending one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA (Prior Month)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa_two_back", + "type": "float | None", + "description": "One-month SA percent change ending two months before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA (Two Months Back)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable2", + "openapi_extra": { + "model": "BlsCpiNrTable2" + } + }, + "/bls/cpi/t3_special_aggregates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 3 \u2014 CPI-U U.S. city average, special aggregate indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U special aggregate indexes.\nobb.bls.cpi.t3_special_aggregates(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable3", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Weight as a percent of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "index_value", + "type": "float | None", + "description": "NSA CPI index at the latest reference month (date).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value", + "cellDataType": "number" + } + } + }, + { + "name": "index_value_prior_month", + "type": "float | None", + "description": "NSA CPI index one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value (Prior Month)", + "cellDataType": "number" + } + } + }, + { + "name": "index_value_year_ago", + "type": "float | None", + "description": "NSA CPI index twelve months before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value (Year Ago)", + "cellDataType": "number" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_nsa", + "type": "float | None", + "description": "One-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa", + "type": "float | None", + "description": "One-month SA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa_prior", + "type": "float | None", + "description": "One-month SA percent change ending one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA (Prior Month)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa_two_back", + "type": "float | None", + "description": "One-month SA percent change ending two months before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA (Two Months Back)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable3", + "openapi_extra": { + "model": "BlsCpiNrTable3" + } + }, + "/bls/cpi/t4_selected_areas": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 4 \u2014 CPI-U selected areas, all items index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U selected areas all-items index.\nobb.bls.cpi.t4_selected_areas(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable4", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pricing_schedule", + "type": "str | None", + "description": "Area pricing schedule code (M = monthly, S = semiannual, B = bimonthly).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_nsa", + "type": "float | None", + "description": "One-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_window", + "type": "float | None", + "description": "Two-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 2M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_window_start_date", + "type": "date | None", + "description": "Start-of-month for the 2-month comparison.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "pct_change_12m_prior", + "type": "float | None", + "description": "Twelve-month percent change ending one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M (Prior Month)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_nsa_prior", + "type": "float | None", + "description": "One-month NSA percent change ending one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA (Prior Month)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_window_prior", + "type": "float | None", + "description": "Two-month NSA percent change ending one month before date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 2M NSA (Prior Month)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_window_prior_start_date", + "type": "date | None", + "description": "Start-of-month for pct_change_window_prior.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable4", + "openapi_extra": { + "model": "BlsCpiNrTable4" + } + }, + "/bls/cpi/t5_chained_vs_cpiu": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 5 \u2014 Chained CPI (C-CPI-U) and CPI-U 1m/12m percent changes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest Chained CPI vs CPI-U time series.\nobb.bls.cpi.t5_chained_vs_cpiu(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable5", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "pct_change_1m_nsa", + "type": "float | None", + "description": "One-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable5", + "openapi_extra": { + "model": "BlsCpiNrTable5" + } + }, + "/bls/cpi/t6_1m_analysis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 6 \u2014 CPI-U U.S. city average, by expenditure category, 1-month analysis.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U 1-month analysis table.\nobb.bls.cpi.t6_1m_analysis(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable6", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Weight as a percent of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa", + "type": "float | None", + "description": "One-month SA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "effect_on_all_items_sa", + "type": "float | None", + "description": "SA contribution to the 1-month All Items change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effect on All Items (SA)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "standard_error_median_price_change", + "type": "float | None", + "description": "Standard error of the median price change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Std Error (Median Price Change)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "largest_or_smallest_since_marker", + "type": "str | None", + "description": "L-/S- marker plus the historical month at which the current SA 1-month change last occurred.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Largest/Smallest Since" + } + } + }, + { + "name": "largest_or_smallest_since_pct", + "type": "float | None", + "description": "SA 1-month percent change recorded at the historical reference month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Largest/Smallest Since (Pct)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable6", + "openapi_extra": { + "model": "BlsCpiNrTable6" + } + }, + "/bls/cpi/t7_12m_analysis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CPI News Release Table 7 \u2014 CPI-U U.S. city average, by expenditure category, 12-month analysis.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U 12-month analysis table.\nobb.bls.cpi.t7_12m_analysis(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month of the CPI release; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiNrTable7", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Weight as a percent of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "effect_on_all_items_nsa", + "type": "float | None", + "description": "NSA contribution to the 12-month All Items change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effect on All Items (NSA)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "standard_error_median_price_change", + "type": "float | None", + "description": "Standard error of the median price change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Std Error (Median Price Change)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "largest_or_smallest_since_marker", + "type": "str | None", + "description": "L-/S- marker plus the historical month at which the current NSA 12-month change last occurred.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Largest/Smallest Since" + } + } + }, + { + "name": "largest_or_smallest_since_pct", + "type": "float | None", + "description": "NSA 12-month percent change recorded at the historical reference month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Largest/Smallest Since (Pct)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Reference month the row's values apply to (first of month).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS expenditure category, item, or area title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers in label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiNrTable7", + "openapi_extra": { + "model": "BlsCpiNrTable7" + } + }, + "/bls/cpi/relative_importance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch BLS CPI relative-importance and weights for one yearly file + sheet.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI relative-importance weights for CPI-U & CPI-W.\nobb.bls.cpi.relative_importance(provider='bls')\n# 2024 weights for selected local areas (Table 2).\nobb.bls.cpi.relative_importance(provider='bls', year=2024, table=2)\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "year", + "type": "int | None", + "description": "Year of the relative-importance file to fetch; None walks back until a published file is found.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "int | None", + "description": "Which of the 7 sheets in the relative-importance XLSX to return.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Table 1 \u2014 U.S. City Average (CPI-U & CPI-W)", + "value": 1 + }, + { + "label": "Table 2 \u2014 Selected local areas (CPI-U & CPI-W)", + "value": 2 + }, + { + "label": "Table 3 \u2014 Selected local areas (CPI-U & CPI-W)", + "value": 3 + }, + { + "label": "Table 4 \u2014 Selected local areas (CPI-U & CPI-W)", + "value": 4 + }, + { + "label": "Table 5 \u2014 Selected local areas (CPI-U & CPI-W)", + "value": 5 + }, + { + "label": "Table 6 \u2014 Selected local areas (CPI-U & CPI-W)", + "value": 6 + }, + { + "label": "Table 7 \u2014 Selected local areas (CPI-U & CPI-W)", + "value": 7 + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiRelativeImportance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "December reference date for the weights.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "BLS item or expenditure-category label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "level", + "type": "int | None", + "description": "Indent depth from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "row_index", + "type": "int", + "description": "Sequential ordering index assigned during parsing.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "Section the row appears under in the source XLSX (Expenditure category or Special aggregate indexes).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "area", + "type": "str | None", + "description": "Geographic area the weight refers to (e.g., U.S. City Average or a selected local area).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers attached to the row's label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "basket", + "type": "str", + "description": "Which CPI basket the weight refers to (CPI-U or CPI-W).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Weight as a percentage of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiRelativeImportance", + "openapi_extra": { + "model": "BlsCpiRelativeImportance" + } + }, + "/bls/cpi/seasonal_factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch BLS CPI revised seasonally-adjusted indexes and seasonal factors.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest BLS CPI revised seasonal factors + adjusted indexes.\nobb.bls.cpi.seasonal_factors(provider='bls')\n# 2024-vintage seasonal factors (covers 2020-2024).\nobb.bls.cpi.seasonal_factors(provider='bls', year=2024)\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "year", + "type": "int | None", + "description": "Release year of the revised seasonal-adjustment file; None walks back until a published file is found.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiSeasonalFactors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "First day of the calendar month the values apply to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "item_code", + "type": "str", + "description": "Short BLS CPI item code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str", + "description": "Full BLS time-series ID.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Human-readable CPI item title.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seasonally_adjusted_index", + "type": "float | None", + "description": "Revised seasonally-adjusted index level.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seasonal_factor", + "type": "float | None", + "description": "Multiplicative seasonal factor (100.000 = no seasonality).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiSeasonalFactors", + "openapi_extra": { + "model": "BlsCpiSeasonalFactors" + } + }, + "/bls/cpi/supplemental_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch one of the BLS CPI supplemental XLSX tables (C-CPI-U, CPI-W, historical, etc.).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI-U U.S. city average expenditure-category table.\nobb.bls.cpi.supplemental_tables(provider='bls')\n# Latest C-CPI-U snapshot.\nobb.bls.cpi.supplemental_tables(provider='bls', table='c-cpi-u')\n# Historical CPI-U index values (back to 1913).\nobb.bls.cpi.supplemental_tables(provider='bls', table='historical-cpi-u-index')\n# One specific monthly snapshot.\nobb.bls.cpi.supplemental_tables(provider='bls', table='cpi-u-us', date='2024-06-01')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "table", + "type": "str | None", + "description": "Which CPI supplemental table to load.", + "default": "cpi-u-us", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "c-cpi-u \u2014 Chained CPI-U U.S. city average, by item.", + "value": "c-cpi-u" + }, + { + "label": "cpi-u-us \u2014 CPI-U U.S. city average, by expenditure category.", + "value": "cpi-u-us" + }, + { + "label": "cpi-u-regional \u2014 CPI-U selected areas, all items index.", + "value": "cpi-u-regional" + }, + { + "label": "cpi-w \u2014 CPI-W U.S. city average, by expenditure category.", + "value": "cpi-w" + }, + { + "label": "historical-cpi-u-index \u2014 Historical CPI-U U.S. city average, all items, monthly indexes.", + "value": "historical-cpi-u-index" + }, + { + "label": "historical-cpi-u-averages \u2014 Historical CPI-U U.S. city average, all items, semiannual and annual averages.", + "value": "historical-cpi-u-averages" + } + ], + "style": { + "popupWidth": 950 + } + } + } + }, + { + "name": "date", + "type": "date | None | str", + "description": "Snapshot month to fetch; None resolves to the most recent published snapshot.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiSupplementalTables", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "Reference date the row's values apply to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str", + "description": "Row label from the source XLSX.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "indent_level", + "type": "int | None", + "description": "Indent depth in the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Reference-date frequency: monthly, semiannual, or annual.", + "default": "monthly", + "optional": true, + "json_schema_extra": {} + }, + { + "name": "index_value", + "type": "float | None", + "description": "Unadjusted (NSA) CPI index level at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value (NSA)", + "cellDataType": "number" + } + } + }, + { + "name": "sa_index_value", + "type": "float | None", + "description": "Seasonally-adjusted CPI index level at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value (SA)", + "cellDataType": "number" + } + } + }, + { + "name": "pct_change_1m_nsa", + "type": "float | None", + "description": "One-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1m_sa", + "type": "float | None", + "description": "One-month seasonally-adjusted percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M SA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_window", + "type": "float | None", + "description": "Two-month NSA percent change ending at date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 2M NSA", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_window_start_date", + "type": "date | None", + "description": "Start-of-month for the pct_change_window comparison.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Relative-importance weight as a percent of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pricing_schedule", + "type": "str | None", + "description": "Pricing-schedule code (M = monthly, S = semiannual, B = bimonthly).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "half", + "type": "str | None", + "description": "Semiannual half (1st or 2nd) for historical-cpi-u-averages rows.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "value_string", + "type": "str | None", + "description": "Raw cell text when the source value is not numeric.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "snapshot_date", + "type": "date", + "description": "Publication month of the source XLSX snapshot.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_key", + "type": "str", + "description": "Which CPI table family this row came from.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source (table, snapshot) tuple.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Human-readable BLS table title for the source snapshot.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "sheet", + "type": "str", + "description": "XLSX sheet name the row was read from.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "row_index", + "type": "int", + "description": "Sequential ordering index assigned during parsing.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Resolved footnote text for any (N) markers attached to the row's label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiSupplementalTables", + "openapi_extra": { + "model": "BlsCpiSupplementalTables" + } + }, + "/bls/cpi/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List BLS CPI release PDFs for the file viewer (current edition + archive back to May 2002).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All CPI release PDFs (current + archive back to May 2002).\nobb.bls.cpi.documents(provider='bls')\n# Only the archive, narrowed to 2024 releases.\nobb.bls.cpi.documents(provider='bls', category='archived', start_date='2024-01-01', end_date='2024-12-31')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Which family of BLS CPI release PDFs to enumerate.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All documents", + "value": "all" + }, + { + "label": "Current release PDF only", + "value": "current" + }, + { + "label": "Archived releases (back to 2002)", + "value": "archived" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "Human-readable document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the PDF on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family (current or archived).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Release publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format of the document.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsCpiDocuments", + "openapi_extra": { + "model": "BlsCpiDocuments" + } + }, + "/bls/cpi/by_category": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Consumer Price Index chart \u2014 Consumer Price Index by Category \u2014 Latest 12-Month % Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.cpi.by_category(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiByCategory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_12m", + "type": "float | None", + "description": "12-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "category", + "type": "str", + "description": "CPI expenditure category.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Category", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiByCategory", + "openapi_extra": { + "model": "BlsCpiByCategory" + } + }, + "/bls/cpi/by_category_line": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Consumer Price Index chart \u2014 Consumer Price Index by Category \u2014 12-Month % Change History.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.cpi.by_category_line(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiByCategoryLine", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "all_items", + "type": "float | None", + "description": "All items.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "All items", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food_at_home", + "type": "float | None", + "description": "Food at home.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food at home", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food_away_from_home", + "type": "float | None", + "description": "Food away from home.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food away from home", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "gasoline", + "type": "float | None", + "description": "Gasoline (all types).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gasoline (all types)", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "electricity", + "type": "float | None", + "description": "Electricity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electricity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "natural_gas", + "type": "float | None", + "description": "Natural gas (piped).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Natural gas (piped)", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "all_items_less_food_energy", + "type": "float | None", + "description": "All items less food and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "All items less food and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "commodities_less_food_energy", + "type": "float | None", + "description": "Commodities less food and energy commodities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodities less food and energy commodities", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "apparel", + "type": "float | None", + "description": "Apparel.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "new_vehicles", + "type": "float | None", + "description": "New vehicles.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New vehicles", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "medical_care_commodities", + "type": "float | None", + "description": "Medical care commodities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Medical care commodities", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services_less_energy", + "type": "float | None", + "description": "Services less energy services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services less energy services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "shelter", + "type": "float | None", + "description": "Shelter.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Shelter", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "medical_care_services", + "type": "float | None", + "description": "Medical care services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Medical care services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "education_and_communication", + "type": "float | None", + "description": "Education and communication.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Education and communication", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiByCategoryLine", + "openapi_extra": { + "model": "BlsCpiByCategoryLine" + } + }, + "/bls/cpi/by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Consumer Price Index chart \u2014 Consumer Price Index by Region and Division \u2014 12-Month % Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.cpi.by_region(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "south", + "type": "float | None", + "description": "South.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "west", + "type": "float | None", + "description": "West.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "midwest", + "type": "float | None", + "description": "Midwest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Midwest", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "northeast", + "type": "float | None", + "description": "Northeast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Northeast", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "south_atlantic", + "type": "float | None", + "description": "South Atlantic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Atlantic", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "mountain", + "type": "float | None", + "description": "Mountain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mountain", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "east_north_central", + "type": "float | None", + "description": "East North Central.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "East North Central", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "new_england", + "type": "float | None", + "description": "New England.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New England", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "east_south_central", + "type": "float | None", + "description": "East South Central.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "East South Central", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pacific", + "type": "float | None", + "description": "Pacific.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pacific", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "west_north_central", + "type": "float | None", + "description": "West North Central.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West North Central", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "middle_atlantic", + "type": "float | None", + "description": "Middle Atlantic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Middle Atlantic", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "west_south_central", + "type": "float | None", + "description": "West South Central.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West South Central", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiByRegion", + "openapi_extra": { + "model": "BlsCpiByRegion" + } + }, + "/bls/cpi/by_metro": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Consumer Price Index chart \u2014 Consumer Price Index by Metropolitan Area \u2014 12-Month % Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.cpi.by_metro(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiByMetro", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "atlanta", + "type": "float | None", + "description": "Atlanta-Sandy Springs-Roswell, GA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Atlanta-Sandy Springs-Roswell, GA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "baltimore", + "type": "float | None", + "description": "Baltimore-Columbia-Towson, MD.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Baltimore-Columbia-Towson, MD", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "boston", + "type": "float | None", + "description": "Boston-Cambridge-Newton, MA-NH.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Boston-Cambridge-Newton, MA-NH", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "chicago", + "type": "float | None", + "description": "Chicago-Naperville-Elgin, IL-IN-WI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chicago-Naperville-Elgin, IL-IN-WI", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "dallas", + "type": "float | None", + "description": "Dallas-Fort Worth-Arlington, TX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dallas-Fort Worth-Arlington, TX", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "denver", + "type": "float | None", + "description": "Denver-Aurora-Lakewood, CO.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denver-Aurora-Lakewood, CO", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "detroit", + "type": "float | None", + "description": "Detroit-Warren-Dearborn, MI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Detroit-Warren-Dearborn, MI", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "houston", + "type": "float | None", + "description": "Houston-The Woodlands-Sugar Land, TX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Houston-The Woodlands-Sugar Land, TX", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "los_angeles", + "type": "float | None", + "description": "Los Angeles-Long Beach-Anaheim, CA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Los Angeles-Long Beach-Anaheim, CA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "miami", + "type": "float | None", + "description": "Miami-Fort Lauderdale-West Palm Beach, FL.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miami-Fort Lauderdale-West Palm Beach, FL", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "minneapolis", + "type": "float | None", + "description": "Minneapolis-St. Paul-Bloomington, MN-WI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Minneapolis-St. Paul-Bloomington, MN-WI", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "new_york", + "type": "float | None", + "description": "New York-Newark-Jersey City, NY-NJ-PA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New York-Newark-Jersey City, NY-NJ-PA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "philadelphia", + "type": "float | None", + "description": "Philadelphia-Camden-Wilmington, PA-NJ-DE-MD.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philadelphia-Camden-Wilmington, PA-NJ-DE-MD", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "phoenix", + "type": "float | None", + "description": "Phoenix-Mesa-Scottsdale, AZ.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Phoenix-Mesa-Scottsdale, AZ", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "riverside", + "type": "float | None", + "description": "Riverside-San Bernardino-Ontario, CA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Riverside-San Bernardino-Ontario, CA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "san_diego", + "type": "float | None", + "description": "San Diego-Carlsbad, CA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "San Diego-Carlsbad, CA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "san_francisco", + "type": "float | None", + "description": "San Francisco-Oakland-Hayward, CA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "San Francisco-Oakland-Hayward, CA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "seattle", + "type": "float | None", + "description": "Seattle-Tacoma-Bellevue, WA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Seattle-Tacoma-Bellevue, WA", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "st_louis", + "type": "float | None", + "description": "St. Louis, MO-IL.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "St. Louis, MO-IL", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "tampa", + "type": "float | None", + "description": "Tampa-St. Petersburg-Clearwater, FL.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tampa-St. Petersburg-Clearwater, FL", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "urban_alaska", + "type": "float | None", + "description": "Urban Alaska.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Urban Alaska", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "urban_hawaii", + "type": "float | None", + "description": "Urban Hawaii.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Urban Hawaii", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "washington_dc", + "type": "float | None", + "description": "Washington-Arlington-Alexandria, DC-VA-MD-WV.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Washington-Arlington-Alexandria, DC-VA-MD-WV", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiByMetro", + "openapi_extra": { + "model": "BlsCpiByMetro" + } + }, + "/bls/cpi/average_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Consumer Price Index chart \u2014 Average Price Data, Selected Items.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.cpi.average_prices(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCpiAveragePrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "bananas", + "type": "float | None", + "description": "Bananas, per lb..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bananas, per lb.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oranges", + "type": "float | None", + "description": "Oranges, Navel, per lb..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oranges, Navel, per lb.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "bread", + "type": "float | None", + "description": "Bread, white, pan, per lb..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bread, white, pan, per lb.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "tomatoes", + "type": "float | None", + "description": "Tomatoes, field grown, per lb..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tomatoes, field grown, per lb.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chicken", + "type": "float | None", + "description": "Chicken, fresh, whole, per lb..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chicken, fresh, whole, per lb.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electricity_kwh", + "type": "float | None", + "description": "Electricity per KWH.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electricity per KWH", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "eggs", + "type": "float | None", + "description": "Eggs, grade A, large, per doz..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eggs, grade A, large, per doz.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "gasoline", + "type": "float | None", + "description": "Gasoline, unleaded regular, per gallon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gasoline, unleaded regular, per gallon", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "ground_chuck", + "type": "float | None", + "description": "Ground chuck, 100% beef, per lb..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ground chuck, 100% beef, per lb.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "utility_gas", + "type": "float | None", + "description": "Utility (piped) gas per therm.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Utility (piped) gas per therm", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "milk", + "type": "float | None", + "description": "Milk, fresh, whole, fortified, per gal..", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Milk, fresh, whole, fortified, per gal.", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCpiAveragePrices", + "openapi_extra": { + "model": "BlsCpiAveragePrices" + } + }, + "/bls/ppi/relative_importance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch a published BLS Producer Price Index relative-importance table.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Final Demand relative importance (default canonical table).\nobb.bls.ppi.relative_importance(provider='bls', category='final_demand')\n# Fetch a specific relative-importance table by id.\nobb.bls.ppi.relative_importance(provider='bls', table_id='ppi-comrlp')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Which Relative Importance Table section to fetch.", + "default": "final_demand", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Final Demand", + "value": "final_demand" + }, + { + "label": "Intermediate Demand by Commodity Type", + "value": "intermediate_demand_commodity" + }, + { + "label": "Intermediate Demand by Production Flow", + "value": "intermediate_demand_flow" + }, + { + "label": "Commodity", + "value": "commodity" + }, + { + "label": "Wherever-Provided Services & Construction", + "value": "service_construction" + } + ] + } + } + }, + { + "name": "table_id", + "type": "str | None", + "description": "Specific BLS PPI Relative Importance table identifier; takes precedence over category.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "PPI Final Demand relative importance \u2014 by individual commodities", + "value": "ppi-fdallrel" + }, + { + "label": "PPI Final Demand relative importance \u2014 by component series", + "value": "ppi-fdgrouprel" + }, + { + "label": "PPI Intermediate Demand by Commodity Type relative importance \u2014 individual", + "value": "ppi-idcallrel" + }, + { + "label": "PPI Intermediate Demand by Commodity Type relative importance \u2014 component", + "value": "ppi-idcgrouprel" + }, + { + "label": "PPI Intermediate Demand by Production Flow relative importance \u2014 individual", + "value": "ppi-idpallrel" + }, + { + "label": "PPI Intermediate Demand by Production Flow relative importance \u2014 component", + "value": "ppi-idpgrouprel" + }, + { + "label": "PPI Commodities relative importance \u2014 all levels", + "value": "ppi-comrlp" + }, + { + "label": "PPI Wherever-Provided Services and Construction relative importance", + "value": "ppi-weprel" + } + ], + "style": { + "popupWidth": 750 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiRelativeImportance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "December reference date for which BLS computed this row's relative-importance weight.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "code", + "type": "str | None", + "description": "Hierarchical PPI, commodity, or industry code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "Human-readable row label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Relative-importance weight, as a percentage of the parent index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table_id", + "type": "str", + "description": "Source BLS table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiRelativeImportance", + "openapi_extra": { + "model": "BlsPpiRelativeImportance" + } + }, + "/bls/ppi/seasonal_factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch a published BLS Producer Price Index seasonal-factor table.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# FD-ID aggregation seasonal factors for the previous five years.\nobb.bls.ppi.seasonal_factors(provider='bls', category='fd_id')\n# Current-year commodity forecast seasonal factors.\nobb.bls.ppi.seasonal_factors(provider='bls', category='forecast')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Which BLS PPI Seasonal Factor Table to fetch.", + "default": "fd_id", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "FD-ID Aggregation Index (previous 5 years)", + "value": "fd_id" + }, + { + "label": "Commodity Index (previous 5 years)", + "value": "commodity" + }, + { + "label": "Commodity Forecast (current year)", + "value": "forecast" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiSeasonalFactors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "First day of the calendar month the seasonal factor applies to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "code", + "type": "str", + "description": "BLS PPI series code with the WPS prefix preserved.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "Human-readable series title as published by BLS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seasonal_factor", + "type": "float | None", + "description": "BLS-published multiplicative seasonal factor where 100.000 means no seasonality.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table_id", + "type": "str", + "description": "Source BLS table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiSeasonalFactors", + "openapi_extra": { + "model": "BlsPpiSeasonalFactors" + } + }, + "/bls/ppi/detailed_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch one table from a BLS monthly PPI Detailed Report (XLSX, 2022+).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest monthly PPI Detailed Report, Table 1 (FD-ID summary).\nobb.bls.ppi.detailed_report(provider='bls')\n# Specific month and table \u2014 unadjusted commodity indexes.\nobb.bls.ppi.detailed_report(provider='bls', date='2026-04-01', table=9)\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "Month of the Detailed Report to fetch; None resolves to the most recent release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "int | None", + "description": "Which of the 14 tables in the monthly PPI Detailed Report to return.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Table 1. Producer Price Index percentage changes and weights for Final Demand-Intermediate Demand (FD-ID) aggregation system, seasonally adjusted.", + "value": 1 + }, + { + "label": "Table 2. Producer Price Index percentage changes for selected Final Demand-Intermediate Demand (FD-ID) aggregations, seasonally adjusted.", + "value": 2 + }, + { + "label": "Table 3. Producer Price Indexes for Final Demand-Intermediate Demand (FD-ID) aggregations, seasonally adjusted.", + "value": 3 + }, + { + "label": "Table 4. Producer Price Index percentage changes and weights for Final Demand-Intermediate Demand (FD-ID) aggregation system, not seasonally adjusted.", + "value": 4 + }, + { + "label": "Table 5. Producer Price Indexes for Final Demand-Intermediate Demand (FD-ID) aggregations, not seasonally adjusted.", + "value": 5 + }, + { + "label": "Table 6. Producer Price Index percentage changes for selected commodity groupings, seasonally adjusted.", + "value": 6 + }, + { + "label": "Table 7. Producer Price Index percentage changes for commodity and service groupings and individual items, not seasonally adjusted.", + "value": 7 + }, + { + "label": "Table 8. Producer Price Indexes and percentage changes for selected commodity groupings, seasonally adjusted.", + "value": 8 + }, + { + "label": "Table 9. Producer Price Indexes for commodity and service groupings and individual items, not seasonally adjusted.", + "value": 9 + }, + { + "label": "Table 10. Producer Price Indexes and percentage changes for the net output of selected NAICS industry sector and 3-digit subsector groups, not seasonally adjusted.", + "value": 10 + }, + { + "label": "Table 11. Producer Price Indexes for the net output of selected NAICS industries and their products, not seasonally adjusted.", + "value": 11 + }, + { + "label": "Table 12. Producer Price Index percentage changes for the net output of selected NAICS industries and their products, not seasonally adjusted.", + "value": 12 + }, + { + "label": "Table 13. Producer Price Indexes and percentage changes for special commodity groupings, not seasonally adjusted.", + "value": 13 + }, + { + "label": "Table 14. Producer Price Indexes and percentage changes for inputs to construction industries and selected construction outputs, not seasonally adjusted.", + "value": 14 + } + ], + "description": "Which of the 14 tables published in the monthly PPI Detailed Report to return. Each table is a different cut of the same release", + "style": { + "popupWidth": 950 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiDetailedReport", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "First day of the calendar month this row's values apply to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "code", + "type": "str | None", + "description": "Concatenated series identifier for the row.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "group_code", + "type": "str | None", + "description": "BLS 'Group code' from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "item_code", + "type": "str | None", + "description": "BLS 'Item code' from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "industry_code", + "type": "str | None", + "description": "NAICS industry code from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "product_code", + "type": "str | None", + "description": "Product breakdown code of an industry's net output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "Human-readable series title from the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "value", + "markdown": "{footnote}" + } + } + } + } + }, + { + "name": "footnote", + "type": "str | None", + "description": "Combined BLS footnote text for any markers on the label.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "level", + "type": "int | None", + "description": "Row indent depth in the source XLSX hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "index_value", + "type": "float | None", + "description": "Price-index value at the date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Value", + "cellDataType": "number" + } + } + }, + { + "name": "pct_change_1m", + "type": "float | None", + "description": "One-month percent change in the index ending at the date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 1M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_12m", + "type": "float | None", + "description": "Twelve-month percent change in the index ending at the date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pct Change 12M", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "Relative-importance weight of this series within its parent aggregate, as a percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "other_index_base", + "type": "str | None", + "description": "Alternative index base period for this row when BLS overrides the table-wide default.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "seasonally_adjusted", + "type": "bool | None", + "description": "Whether the values on this row are seasonally adjusted.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_name", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_number", + "type": "int", + "description": "Which of the 14 numbered tables in the monthly PPI Detailed Report this row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_period", + "type": "str", + "description": "Reporting month of the source release.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiDetailedReport", + "openapi_extra": { + "model": "BlsPpiDetailedReport" + } + }, + "/bls/ppi/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List published BLS PPI PDF documents for the multi-file viewer widget.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Browse the monthly PPI Detailed Report PDF archive.\nobb.bls.ppi.documents(provider='bls', category='detailed_report')\n# Detailed Report PDFs for a single year.\nobb.bls.ppi.documents(provider='bls', category='detailed_report', year=2024)\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "PPI document family. Only the monthly Detailed Report archive is published.", + "default": "detailed_report", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int | None", + "description": "Filter the monthly Detailed Report archive to a single calendar year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Years", + "value": null + }, + { + "label": "2026", + "value": 2026 + }, + { + "label": "2025", + "value": 2025 + }, + { + "label": "2024", + "value": 2024 + }, + { + "label": "2023", + "value": 2023 + }, + { + "label": "2022", + "value": 2022 + }, + { + "label": "2021", + "value": 2021 + }, + { + "label": "2020", + "value": 2020 + }, + { + "label": "2019", + "value": 2019 + }, + { + "label": "2018", + "value": 2018 + }, + { + "label": "2017", + "value": 2017 + }, + { + "label": "2016", + "value": 2016 + }, + { + "label": "2015", + "value": 2015 + }, + { + "label": "2014", + "value": 2014 + }, + { + "label": "2013", + "value": 2013 + }, + { + "label": "2012", + "value": 2012 + }, + { + "label": "2011", + "value": 2011 + }, + { + "label": "2010", + "value": 2010 + }, + { + "label": "2009", + "value": 2009 + }, + { + "label": "2008", + "value": 2008 + }, + { + "label": "2007", + "value": 2007 + }, + { + "label": "2006", + "value": 2006 + }, + { + "label": "2005", + "value": 2005 + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "Human-readable document title for display in the file picker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the PDF on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family, matching the category query parameter.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Reporting month for the monthly Detailed Report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format suffix.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsPpiDocuments", + "openapi_extra": { + "model": "BlsPpiDocuments" + } + }, + "/bls/ppi/final_demand_1m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Final Demand \u2014 1-Month % Change (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.final_demand_1m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiFinalDemand1m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_less_foods_energy_trade", + "type": "float | None", + "description": "Total less foods, energy, and trade services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total less foods, energy, and trade services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods", + "type": "float | None", + "description": "Goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "foods", + "type": "float | None", + "description": "Foods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Foods", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods_less_foods_energy", + "type": "float | None", + "description": "Goods less foods and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods less foods and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services", + "type": "float | None", + "description": "Services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "trade", + "type": "float | None", + "description": "Trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "transportation_warehousing", + "type": "float | None", + "description": "Transportation and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation and warehousing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services_less_trade_transport_warehousing", + "type": "float | None", + "description": "Services less trade, transportation, and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services less trade, transportation, and warehousing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiFinalDemand1m", + "openapi_extra": { + "model": "BlsPpiFinalDemand1m" + } + }, + "/bls/ppi/final_demand_12m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Final Demand \u2014 12-Month % Change (NSA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.final_demand_12m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiFinalDemand12m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_less_foods_energy_trade", + "type": "float | None", + "description": "Total less foods, energy, and trade services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total less foods, energy, and trade services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods", + "type": "float | None", + "description": "Goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "foods", + "type": "float | None", + "description": "Foods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Foods", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods_less_foods_energy", + "type": "float | None", + "description": "Goods less foods and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods less foods and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services", + "type": "float | None", + "description": "Services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "trade", + "type": "float | None", + "description": "Trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "transportation_warehousing", + "type": "float | None", + "description": "Transportation and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation and warehousing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services_less_trade_transport_warehousing", + "type": "float | None", + "description": "Services less trade, transportation, and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services less trade, transportation, and warehousing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiFinalDemand12m", + "openapi_extra": { + "model": "BlsPpiFinalDemand12m" + } + }, + "/bls/ppi/final_demand_components_1m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Final Demand Components \u2014 1-Month % Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.final_demand_components_1m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiFinalDemandComponents1m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_1m", + "type": "float | None", + "description": "1-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "commodity", + "type": "str", + "description": "Final-demand commodity / component.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiFinalDemandComponents1m", + "openapi_extra": { + "model": "BlsPpiFinalDemandComponents1m" + } + }, + "/bls/ppi/final_demand_components_12m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Final Demand Components \u2014 12-Month % Change (NSA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.final_demand_components_12m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiFinalDemandComponents12m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_12m", + "type": "float | None", + "description": "12-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "commodity", + "type": "str", + "description": "Final-demand commodity / component.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiFinalDemandComponents12m", + "openapi_extra": { + "model": "BlsPpiFinalDemandComponents12m" + } + }, + "/bls/ppi/intermediate_unprocessed_1m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Intermediate Demand, Unprocessed Goods \u2014 1-Month % Change (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.intermediate_unprocessed_1m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiIntermediateUnprocessed1m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "overall", + "type": "float | None", + "description": "Overall.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overall", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods_less_food_energy", + "type": "float | None", + "description": "Goods other than food and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods other than food and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiIntermediateUnprocessed1m", + "openapi_extra": { + "model": "BlsPpiIntermediateUnprocessed1m" + } + }, + "/bls/ppi/intermediate_unprocessed_12m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Intermediate Demand, Unprocessed Goods \u2014 12-Month % Change (NSA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.intermediate_unprocessed_12m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiIntermediateUnprocessed12m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "overall", + "type": "float | None", + "description": "Overall.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overall", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods_less_food_energy", + "type": "float | None", + "description": "Goods other than food and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods other than food and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiIntermediateUnprocessed12m", + "openapi_extra": { + "model": "BlsPpiIntermediateUnprocessed12m" + } + }, + "/bls/ppi/intermediate_processed_1m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Intermediate Demand, Processed Goods \u2014 1-Month % Change (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.intermediate_processed_1m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiIntermediateProcessed1m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "overall", + "type": "float | None", + "description": "Overall.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overall", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods_less_food_energy", + "type": "float | None", + "description": "Goods other than food and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods other than food and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiIntermediateProcessed1m", + "openapi_extra": { + "model": "BlsPpiIntermediateProcessed1m" + } + }, + "/bls/ppi/intermediate_processed_12m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Intermediate Demand, Processed Goods \u2014 12-Month % Change (NSA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.intermediate_processed_12m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiIntermediateProcessed12m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "overall", + "type": "float | None", + "description": "Overall.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overall", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy", + "type": "float | None", + "description": "Energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "goods_less_food_energy", + "type": "float | None", + "description": "Goods other than food and energy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Goods other than food and energy", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiIntermediateProcessed12m", + "openapi_extra": { + "model": "BlsPpiIntermediateProcessed12m" + } + }, + "/bls/ppi/intermediate_services_1m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Intermediate Demand, Services \u2014 1-Month % Change (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.intermediate_services_1m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiIntermediateServices1m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "overall", + "type": "float | None", + "description": "Overall.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overall", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "less_trade_transport_warehousing", + "type": "float | None", + "description": "Less trade, transportation, and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Less trade, transportation, and warehousing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "transportation_warehousing", + "type": "float | None", + "description": "Transportation and warehousing services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation and warehousing services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "trade", + "type": "float | None", + "description": "Trade services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiIntermediateServices1m", + "openapi_extra": { + "model": "BlsPpiIntermediateServices1m" + } + }, + "/bls/ppi/intermediate_services_12m": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Producer Price Index chart \u2014 Intermediate Demand, Services \u2014 12-Month % Change (NSA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.ppi.intermediate_services_12m(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsPpiIntermediateServices12m", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "overall", + "type": "float | None", + "description": "Overall.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overall", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "less_trade_transport_warehousing", + "type": "float | None", + "description": "Less trade, transportation, and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Less trade, transportation, and warehousing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "transportation_warehousing", + "type": "float | None", + "description": "Transportation and warehousing services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation and warehousing services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "trade", + "type": "float | None", + "description": "Trade services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsPpiIntermediateServices12m", + "openapi_extra": { + "model": "BlsPpiIntermediateServices12m" + } + }, + "/bls/jolts/change_analysis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch a JOLTS change-analysis TXT table (estimated rate/level changes + significance).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# National JOLTS Table 1 \u2014 Job openings SA over-the-month.\nobb.bls.jolts.change_analysis(provider='bls')\n# National Table 10 \u2014 Quits NSA over-the-year.\nobb.bls.jolts.change_analysis(provider='bls', table_number=10)\n# State Table 1 \u2014 Job openings by state SA over-the-month.\nobb.bls.jolts.change_analysis(provider='bls', scope='state', table_number=1)\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "scope", + "type": "str | None", + "description": "JOLTS change-analysis family to load.", + "default": "national", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "table_number", + "type": "int | None", + "description": "Numbered change-analysis table to load.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "style": { + "popupWidth": 950 + }, + "options": [ + { + "label": "National Table 1 \u2014 Job openings over-the-month (SA)", + "value": 1 + }, + { + "label": "National Table 2 \u2014 Hires over-the-month (SA)", + "value": 2 + }, + { + "label": "National Table 3 \u2014 Total separations over-the-month (SA)", + "value": 3 + }, + { + "label": "National Table 4 \u2014 Quits over-the-month (SA)", + "value": 4 + }, + { + "label": "National Table 5 \u2014 Layoffs and discharges over-the-month (SA)", + "value": 5 + }, + { + "label": "National Table 6 \u2014 Other separations over-the-month (SA)", + "value": 6 + }, + { + "label": "National Table 7 \u2014 Job openings over-the-year (NSA)", + "value": 7 + }, + { + "label": "National Table 8 \u2014 Hires over-the-year (NSA)", + "value": 8 + }, + { + "label": "National Table 9 \u2014 Total separations over-the-year (NSA)", + "value": 9 + }, + { + "label": "National Table 10 \u2014 Quits over-the-year (NSA)", + "value": 10 + }, + { + "label": "National Table 11 \u2014 Layoffs and discharges over-the-year (NSA)", + "value": 11 + }, + { + "label": "National Table 12 \u2014 Other separations over-the-year (NSA)", + "value": 12 + }, + { + "label": "State Table 1 \u2014 Job openings over-the-month (SA)", + "value": 101 + }, + { + "label": "State Table 2 \u2014 Hires over-the-month (SA)", + "value": 102 + }, + { + "label": "State Table 3 \u2014 Total separations over-the-month (SA)", + "value": 103 + }, + { + "label": "State Table 4 \u2014 Quits over-the-month (SA)", + "value": 104 + }, + { + "label": "State Table 5 \u2014 Layoffs and discharges over-the-month (SA)", + "value": 105 + }, + { + "label": "State Table 6 \u2014 Job openings over-the-year (NSA)", + "value": 106 + }, + { + "label": "State Table 7 \u2014 Hires over-the-year (NSA)", + "value": 107 + }, + { + "label": "State Table 8 \u2014 Total separations over-the-year (NSA)", + "value": 108 + }, + { + "label": "State Table 9 \u2014 Quits over-the-year (NSA)", + "value": 109 + }, + { + "label": "State Table 10 \u2014 Layoffs and discharges over-the-year (NSA)", + "value": 110 + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsChangeAnalysis", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "scope", + "type": "str", + "description": "National or state scope of the table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_number", + "type": "int", + "description": "Source table number within the scope.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "measure", + "type": "str", + "description": "JOLTS measure published in this table.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "Comparison window for the table.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "seasonally_adjusted", + "type": "bool | None", + "description": "Whether the table is seasonally adjusted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_start", + "type": "date | None", + "description": "First-of-month start date of the comparison window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_end", + "type": "date | None", + "description": "First-of-month end date of the comparison window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source_date", + "type": "date | None", + "description": "Release date stamped in the TXT footer.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "row_index", + "type": "int", + "description": "Sequential ordering index preserving the source row order.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "Section header the row appears under in the source TXT.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indent_spaces", + "type": "int", + "description": "Leading-space count from the source TXT encoding hierarchy depth.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "label", + "type": "str", + "description": "Row label \u2014 industry, region, or state name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate_change", + "type": "float | None", + "description": "Estimated rate change in percentage points over the comparison window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_min_significant", + "type": "float | None", + "description": "Minimum rate change in percentage points needed to reach 90-percent significance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_passes_significance", + "type": "bool | None", + "description": "Whether the rate change is statistically significant at 90 percent.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level_change_thousands", + "type": "float | None", + "description": "Estimated level change in thousands over the comparison window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level_min_significant_thousands", + "type": "float | None", + "description": "Minimum level change in thousands needed to reach 90-percent significance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level_passes_significance", + "type": "bool | None", + "description": "Whether the level change is statistically significant at 90 percent.", + "default": false, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsJoltsChangeAnalysis", + "openapi_extra": { + "model": "BlsJoltsChangeAnalysis" + } + }, + "/bls/jolts/revisions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch the JOLTS SA/NSA revision XLSX in long form (1st / 2nd / benchmark levels + revision deltas).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Full seasonally-adjusted JOLTS revision workbook.\nobb.bls.jolts.revisions(provider='bls')\n# NSA revision rows for Construction (industry code 23) only.\nobb.bls.jolts.revisions(provider='bls', seasonally_adjusted=False, industry_code='23')\n# SA Quits revisions across every industry / region.\nobb.bls.jolts.revisions(provider='bls', measure='Quits')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "seasonally_adjusted", + "type": "bool | None", + "description": "Whether to return the seasonally-adjusted revision workbook.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "industry_code", + "type": "str | None", + "description": "Optional industry or region sheet code to restrict the results.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "measure", + "type": "str | None", + "description": "Optional measure name to restrict the results.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsRevisions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "First-of-month reference date the revision values describe.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "industry_code", + "type": "str", + "description": "BLS industry or region sheet code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "industry_name", + "type": "str", + "description": "Human-readable industry or region name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "seasonally_adjusted", + "type": "bool", + "description": "Whether the row comes from the seasonally-adjusted workbook.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "measure", + "type": "str", + "description": "JOLTS measure for the row.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "level_1st", + "type": "float | None", + "description": "First-published level (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1st (level)", + "cellDataType": "number" + } + } + }, + { + "name": "level_2nd", + "type": "float | None", + "description": "Second-revision level (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2nd (level)", + "cellDataType": "number" + } + } + }, + { + "name": "level_benchmark", + "type": "float | None", + "description": "Benchmarked level (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Benchmark (level)", + "cellDataType": "number" + } + } + }, + { + "name": "revision_1st_to_2nd_level", + "type": "float | None", + "description": "Level change from first-published to second-revision (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Revision 1st\u21922nd (level)", + "cellDataType": "number" + } + } + }, + { + "name": "revision_1st_to_2nd_pct", + "type": "float | None", + "description": "Percent change from first-published to second-revision.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Revision 1st\u21922nd (%)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "revision_2nd_to_benchmark_level", + "type": "float | None", + "description": "Level change from second-revision to benchmark (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Revision 2nd\u2192Benchmark (level)", + "cellDataType": "number" + } + } + }, + { + "name": "revision_2nd_to_benchmark_pct", + "type": "float | None", + "description": "Percent change from second-revision to benchmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Revision 2nd\u2192Benchmark (%)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "row_index", + "type": "int", + "description": "Sequential parser order.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the workbook.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Human-readable workbook title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsRevisions", + "openapi_extra": { + "model": "BlsJoltsRevisions" + } + }, + "/bls/jolts/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List BLS JOLTS release PDFs / supplementals / archived releases for the file viewer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All current JOLTS PDFs + supplemental files.\nobb.bls.jolts.documents(provider='bls')\n# Every archived national JOLTS release.\nobb.bls.jolts.documents(provider='bls', category='archived', release_code='jolts')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Family of BLS JOLTS PDFs to enumerate.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All documents", + "value": "all" + }, + { + "label": "National (current release PDF)", + "value": "national" + }, + { + "label": "State (current release PDF)", + "value": "state" + }, + { + "label": "Archived releases (historical PDFs)", + "value": "archived" + } + ] + } + } + }, + { + "name": "release_code", + "type": "str | None", + "description": "Optional release code to restrict the results.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest publication date to include (inclusive).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest publication date to include (inclusive).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "Human-readable document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the file on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "release_code", + "type": "str | None", + "description": "Source release code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Publication date of the document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format of the document.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsJoltsDocuments", + "openapi_extra": { + "model": "BlsJoltsDocuments" + } + }, + "/bls/jolts/unemp_per_opening": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Unemployed Persons per Job Opening (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.unemp_per_opening(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsUnempPerOpening", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "number_of_unemployed_persons_per_job_opening", + "type": "float | None", + "description": "Number of unemployed persons per job opening.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Number of unemployed persons per job opening", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsUnempPerOpening", + "openapi_extra": { + "model": "BlsJoltsUnempPerOpening" + } + }, + "/bls/jolts/openings_hires_seps_levels": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Job Openings, Hires, and Separations \u2014 Levels (SA, thousands).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.openings_hires_seps_levels(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsOpeningsHiresSepsLevels", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_nonfarm_job_openings", + "type": "float | None", + "description": "Total nonfarm job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm job openings", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "total_nonfarm_hires", + "type": "float | None", + "description": "Total nonfarm hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm hires", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "total_nonfarm_separations", + "type": "float | None", + "description": "Total nonfarm separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm separations", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "total_private_job_openings", + "type": "float | None", + "description": "Total private job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private job openings", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "total_private_hires", + "type": "float | None", + "description": "Total private hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private hires", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "total_private_separations", + "type": "float | None", + "description": "Total private separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private separations", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "government_job_openings", + "type": "float | None", + "description": "Government job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government job openings", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "government_hires", + "type": "float | None", + "description": "Government hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government hires", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "government_separations", + "type": "float | None", + "description": "Government separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government separations", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsOpeningsHiresSepsLevels", + "openapi_extra": { + "model": "BlsJoltsOpeningsHiresSepsLevels" + } + }, + "/bls/jolts/openings_hires_seps_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Job Openings, Hires, and Separations \u2014 Rates (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.openings_hires_seps_rates(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsOpeningsHiresSepsRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_nonfarm_job_openings", + "type": "float | None", + "description": "Total nonfarm job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_nonfarm_hires", + "type": "float | None", + "description": "Total nonfarm hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_nonfarm_separations", + "type": "float | None", + "description": "Total nonfarm separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_private_job_openings", + "type": "float | None", + "description": "Total private job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_private_hires", + "type": "float | None", + "description": "Total private hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_private_separations", + "type": "float | None", + "description": "Total private separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "government_job_openings", + "type": "float | None", + "description": "Government job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "government_hires", + "type": "float | None", + "description": "Government hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "government_separations", + "type": "float | None", + "description": "Government separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsOpeningsHiresSepsRates", + "openapi_extra": { + "model": "BlsJoltsOpeningsHiresSepsRates" + } + }, + "/bls/jolts/hires_seps_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Total Nonfarm Hires and Separations Rates (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.hires_seps_rates(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsHiresSepsRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "hires", + "type": "float | None", + "description": "Hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_separations", + "type": "float | None", + "description": "Total separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "quits", + "type": "float | None", + "description": "Quits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quits", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "layoffs_and_discharges", + "type": "float | None", + "description": "Layoffs and discharges.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Layoffs and discharges", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "other_separations", + "type": "float | None", + "description": "Other separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsHiresSepsRates", + "openapi_extra": { + "model": "BlsJoltsHiresSepsRates" + } + }, + "/bls/jolts/openings_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Job Openings Rates by Industry (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.openings_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsOpeningsByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_nonfarm", + "type": "float | None", + "description": "Total nonfarm.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "mining_and_logging", + "type": "float | None", + "description": "Mining and logging.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining and logging", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "construction", + "type": "float | None", + "description": "Construction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Construction", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "durable_goods_manufacturing", + "type": "float | None", + "description": "Durable goods manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Durable goods manufacturing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "nondurable_goods_manufacturing", + "type": "float | None", + "description": "Nondurable goods manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nondurable goods manufacturing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "wholesale_trade", + "type": "float | None", + "description": "Wholesale trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "retail_trade", + "type": "float | None", + "description": "Retail trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "transportation_warehousing_and_utilities", + "type": "float | None", + "description": "Transportation, warehousing, and utilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation, warehousing, and utilities", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "information", + "type": "float | None", + "description": "Information.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Information", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "finance_and_insurance", + "type": "float | None", + "description": "Finance and insurance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance and insurance", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "real_estate_and_rental_and_leasing", + "type": "float | None", + "description": "Real estate and rental and leasing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate and rental and leasing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "professional_and_business_services", + "type": "float | None", + "description": "Professional and business services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Professional and business services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "private_educational_services", + "type": "float | None", + "description": "Private educational services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Private educational services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "health_care_and_social_assistance", + "type": "float | None", + "description": "Health care and social assistance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Health care and social assistance", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "arts_entertainment_and_recreation", + "type": "float | None", + "description": "Arts, entertainment, and recreation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Arts, entertainment, and recreation", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "accommodation_and_food_services", + "type": "float | None", + "description": "Accommodation and food services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Accommodation and food services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "other_services", + "type": "float | None", + "description": "Other services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other services", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "federal_government", + "type": "float | None", + "description": "Federal government.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Federal government", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "state_and_local_government_education", + "type": "float | None", + "description": "State and local government education.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State and local government education", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "state_and_local_government_excluding_education", + "type": "float | None", + "description": "State and local government, excluding education.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State and local government, excluding education", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsOpeningsByIndustry", + "openapi_extra": { + "model": "BlsJoltsOpeningsByIndustry" + } + }, + "/bls/jolts/openings_hires_seps_by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Job Openings, Hires, and Separations Rates by Region (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.openings_hires_seps_by_region(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsOpeningsHiresSepsByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "u_s_job_openings", + "type": "float | None", + "description": "U.S. job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U.S. job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "u_s_hires", + "type": "float | None", + "description": "U.S. hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U.S. hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "u_s_separations", + "type": "float | None", + "description": "U.S. separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U.S. separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "northeast_job_openings", + "type": "float | None", + "description": "Northeast job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Northeast job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "northeast_hires", + "type": "float | None", + "description": "Northeast hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Northeast hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "northeast_separations", + "type": "float | None", + "description": "Northeast separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Northeast separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "south_job_openings", + "type": "float | None", + "description": "South job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "south_hires", + "type": "float | None", + "description": "South hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "south_separations", + "type": "float | None", + "description": "South separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "midwest_job_openings", + "type": "float | None", + "description": "Midwest job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Midwest job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "midwest_hires", + "type": "float | None", + "description": "Midwest hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Midwest hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "midwest_separations", + "type": "float | None", + "description": "Midwest separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Midwest separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "west_job_openings", + "type": "float | None", + "description": "West job openings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West job openings", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "west_hires", + "type": "float | None", + "description": "West hires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West hires", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "west_separations", + "type": "float | None", + "description": "West separations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West separations", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsOpeningsHiresSepsByRegion", + "openapi_extra": { + "model": "BlsJoltsOpeningsHiresSepsByRegion" + } + }, + "/bls/jolts/beveridge_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Job Openings and Labor Turnover chart \u2014 Beveridge Curve \u2014 Job Openings Rate vs. Unemployment Rate (SA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.jolts.beveridge_curve(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsJoltsBeveridgeCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "job_openings_rate", + "type": "float | None", + "description": "Job openings rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Job openings rate", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "unemployment_rate", + "type": "float | None", + "description": "Unemployment rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unemployment rate", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsJoltsBeveridgeCurve", + "openapi_extra": { + "model": "BlsJoltsBeveridgeCurve" + } + }, + "/bls/employment_situation/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List BLS Employment Situation release PDFs for the file viewer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All Employment Situation release PDFs (current + archive).\nobb.bls.employment_situation.documents(provider='bls')\n# Only 2024 archived releases.\nobb.bls.employment_situation.documents(provider='bls', category='archived', start_date='2024-01-01', end_date='2024-12-31')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Which family of BLS Employment Situation release PDFs to enumerate.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All documents", + "value": "all" + }, + { + "label": "Current release PDF only", + "value": "current" + }, + { + "label": "Archived releases", + "value": "archived" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "Human-readable document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the PDF on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family (current or archived).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Release publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format of the document.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsEmpsitDocuments", + "openapi_extra": { + "model": "BlsEmpsitDocuments" + } + }, + "/bls/employment_situation/summary_household": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Employment Situation Summary Table A \u2014 household data, seasonally adjusted.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.summary_household(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitSummaryA", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_1_month", + "type": "float | None", + "description": "Over-the-month change (prior month to latest).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1-Month Change", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "Section heading the row falls under.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "category", + "type": "str", + "description": "Row category / metric.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "year_ago", + "type": "float | None", + "description": "Value for the same month a year ago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year Ago", + "cellDataType": "number" + } + } + }, + { + "name": "two_months_prior", + "type": "float | None", + "description": "Value two months before the latest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2 Months Prior", + "cellDataType": "number" + } + } + }, + { + "name": "prior_month", + "type": "float | None", + "description": "Value for the month before the latest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prior Month", + "cellDataType": "number" + } + } + }, + { + "name": "latest", + "type": "float | None", + "description": "Value for the latest (most recent) month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latest", + "cellDataType": "number" + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitSummaryA", + "openapi_extra": { + "model": "BlsEmpsitSummaryA" + } + }, + "/bls/employment_situation/summary_establishment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Employment Situation Summary Table B \u2014 establishment data, seasonally adjusted.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.summary_establishment(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitSummaryB", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "section", + "type": "str | None", + "description": "Section heading the row falls under.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "category", + "type": "str", + "description": "Row category / metric.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "year_ago", + "type": "float | None", + "description": "Value for the same month a year ago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year Ago", + "cellDataType": "number" + } + } + }, + { + "name": "two_months_prior", + "type": "float | None", + "description": "Value two months before the latest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2 Months Prior", + "cellDataType": "number" + } + } + }, + { + "name": "prior_month", + "type": "float | None", + "description": "Value for the month before the latest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prior Month", + "cellDataType": "number" + } + } + }, + { + "name": "latest", + "type": "float | None", + "description": "Value for the latest (most recent) month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latest", + "cellDataType": "number" + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitSummaryB", + "openapi_extra": { + "model": "BlsEmpsitSummaryB" + } + }, + "/bls/employment_situation/t1_employment_changes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 1 \u2014 employment normal seasonal movements, OTM changes, significance.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t1_employment_changes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable1", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "indent_level", + "type": "int | None", + "description": "Hierarchy depth.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Level" + } + } + }, + { + "name": "normal_seasonal_movement", + "type": "float | None", + "description": "Normal (expected) NSA seasonal movement, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Normal Seasonal Movement (NSA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_nsa", + "type": "float | None", + "description": "Actual NSA over-the-month change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (NSA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_sa", + "type": "float | None", + "description": "Seasonally adjusted over-the-month change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (SA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_sa_significant", + "type": "bool | None", + "description": "Whether the SA change passed the test of significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "SA Change Significant" + } + } + }, + { + "name": "minimum_significant_change", + "type": "float | None", + "description": "Minimum SA change required for statistical significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Minimum Significant Change", + "cellDataType": "number" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable1", + "openapi_extra": { + "model": "BlsCesTable1" + } + }, + "/bls/employment_situation/t2_ranked_industries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 2 \u2014 detailed industries ranked by over-the-month change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t2_ranked_industries(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable2", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "rank", + "type": "str | None", + "description": "Rank by over-the-month change (ties share a rank).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rank" + } + } + }, + { + "name": "naics_code", + "type": "str | None", + "description": "NAICS industry code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "NAICS" + } + } + }, + { + "name": "change_sa", + "type": "float | None", + "description": "Seasonally adjusted over-the-month change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (SA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_sa_significant", + "type": "bool | None", + "description": "Whether the SA change passed the test of significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Significant" + } + } + }, + { + "name": "minimum_significant_change", + "type": "float | None", + "description": "Minimum SA change required for statistical significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Minimum Significant Change", + "cellDataType": "number" + } + } + }, + { + "name": "prior_3month_average", + "type": "float | None", + "description": "Prior 3-month average change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prior 3-Month Average", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable2", + "openapi_extra": { + "model": "BlsCesTable2" + } + }, + "/bls/employment_situation/t3a_employment_changes_sa": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 3A \u2014 SA employment changes and tests of significance.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t3a_employment_changes_sa(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable3A", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "indent_level", + "type": "int | None", + "description": "Hierarchy depth.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Level" + } + } + }, + { + "name": "otm_change_latest", + "type": "float | None", + "description": "Over-the-month change for the latest month, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (Latest)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "otm_change_latest_significant", + "type": "bool | None", + "description": "Whether the latest OTM change is significant.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "otm_change_prior_1", + "type": "float | None", + "description": "Over-the-month change one month prior (revised), in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (1 Mo Prior)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "otm_change_prior_1_significant", + "type": "bool | None", + "description": "Whether the prior-month OTM change is significant.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "otm_change_prior_2", + "type": "float | None", + "description": "Over-the-month change two months prior (revised), in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (2 Mo Prior)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "otm_change_prior_2_significant", + "type": "bool | None", + "description": "Whether the two-months-prior OTM change is significant.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "current_3month_change", + "type": "float | None", + "description": "Current 3-month change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Current 3-Month Change", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "current_3month_change_significant", + "type": "bool | None", + "description": "Whether the current 3-month change is significant.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "current_6month_change", + "type": "float | None", + "description": "Current 6-month change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Current 6-Month Change", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "current_6month_change_significant", + "type": "bool | None", + "description": "Whether the current 6-month change is significant.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "current_12month_change", + "type": "float | None", + "description": "Current 12-month change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Current 12-Month Change", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "current_12month_change_significant", + "type": "bool | None", + "description": "Whether the current 12-month change is significant.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable3A", + "openapi_extra": { + "model": "BlsCesTable3A" + } + }, + "/bls/employment_situation/t3b_changes_vs_averages": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 3B \u2014 over-the-month changes compared with recent averages.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t3b_changes_vs_averages(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable3B", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "indent_level", + "type": "int | None", + "description": "Hierarchy depth.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Level" + } + } + }, + { + "name": "otm_change_latest", + "type": "float | None", + "description": "Over-the-month change for the latest month, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (Latest)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "otm_change_prior_1", + "type": "float | None", + "description": "Over-the-month change one month prior, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (1 Mo Prior)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "otm_change_prior_2", + "type": "float | None", + "description": "Over-the-month change two months prior, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (2 Mo Prior)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "prior_3month_average", + "type": "float | None", + "description": "Prior 3-month average change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prior 3-Month Average", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "prior_6month_average", + "type": "float | None", + "description": "Prior 6-month average change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prior 6-Month Average", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "prior_12month_average", + "type": "float | None", + "description": "Prior 12-month average change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prior 12-Month Average", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable3B", + "openapi_extra": { + "model": "BlsCesTable3B" + } + }, + "/bls/employment_situation/t4_over_the_year_changes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 4 \u2014 over-the-year employment changes and significance.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t4_over_the_year_changes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable4", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "indent_level", + "type": "int | None", + "description": "Hierarchy depth.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Level" + } + } + }, + { + "name": "oty_change_number", + "type": "float | None", + "description": "Over-the-year change, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTY Change (Number)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "oty_change_number_significant", + "type": "bool | None", + "description": "Whether the OTY change passed the test of significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTY Change Significant" + } + } + }, + { + "name": "oty_change_percent", + "type": "float | None", + "description": "Over-the-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTY Change (Percent)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "minimum_significant_change", + "type": "float | None", + "description": "Minimum change required for statistical significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Minimum Significant Change", + "cellDataType": "number" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable4", + "openapi_extra": { + "model": "BlsCesTable4" + } + }, + "/bls/employment_situation/t5_hours_earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 5 \u2014 average weekly hours and average hourly earnings changes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t5_hours_earnings(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable5", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "measure", + "type": "str | None", + "description": "Which series block the row belongs to (hours or earnings).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Measure" + } + } + }, + { + "name": "normal_seasonal_movement", + "type": "float | None", + "description": "Normal (expected) NSA seasonal movement.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Normal Seasonal Movement (NSA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_nsa", + "type": "float | None", + "description": "Actual NSA over-the-month change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (NSA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_sa", + "type": "float | None", + "description": "Seasonally adjusted over-the-month change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (SA)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_sa_significant", + "type": "bool | None", + "description": "Whether the SA change passed the test of significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "SA Change Significant" + } + } + }, + { + "name": "minimum_significant_change", + "type": "float | None", + "description": "Minimum SA change required for statistical significance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Minimum Significant Change", + "cellDataType": "number" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable5", + "openapi_extra": { + "model": "BlsCesTable5" + } + }, + "/bls/employment_situation/t6_aggregate_hours_payrolls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 6 \u2014 aggregate weekly hours and payroll changes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t6_aggregate_hours_payrolls(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable6", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "measure", + "type": "str | None", + "description": "Which series block the row belongs to (hours or payrolls).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Measure" + } + } + }, + { + "name": "aggregate_value", + "type": "float | None", + "description": "Aggregate level \u2014 weekly hours or weekly payrolls per the measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Aggregate", + "cellDataType": "number" + } + } + }, + { + "name": "otm_change_number", + "type": "float | None", + "description": "Over-the-month change in aggregate weekly hours, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (Number)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "otm_change_percent", + "type": "float | None", + "description": "Over-the-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTM Change (Percent)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "oty_change_number", + "type": "float | None", + "description": "Over-the-year change in aggregate weekly hours, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTY Change (Number)", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "oty_change_percent", + "type": "float | None", + "description": "Over-the-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "OTY Change (Percent)", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable6", + "openapi_extra": { + "model": "BlsCesTable6" + } + }, + "/bls/employment_situation/t7_peak_trough": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Table 7 \u2014 most recent employment peak/trough and changes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.t7_peak_trough(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesTable7", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "indent_level", + "type": "int | None", + "description": "Hierarchy depth.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Level" + } + } + }, + { + "name": "current_employment", + "type": "float | None", + "description": "Current employment at the reference month, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Current Employment", + "cellDataType": "number" + } + } + }, + { + "name": "peak_date", + "type": "date | None", + "description": "Month of the most recent employment peak.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peak Month" + } + } + }, + { + "name": "peak_employment", + "type": "float | None", + "description": "Employment at the most recent peak, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peak Employment", + "cellDataType": "number" + } + } + }, + { + "name": "trough_date", + "type": "date | None", + "description": "Month of the most recent employment trough.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trough Month" + } + } + }, + { + "name": "trough_employment", + "type": "float | None", + "description": "Employment at the most recent trough, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trough Employment", + "cellDataType": "number" + } + } + }, + { + "name": "change_from_peak", + "type": "float | None", + "description": "Change from peak to current employment, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Change from Peak", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_from_trough", + "type": "float | None", + "description": "Change from trough to current employment, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Change from Trough", + "cellDataType": "number", + "renderFn": "greenRed" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesTable7", + "openapi_extra": { + "model": "BlsCesTable7" + } + }, + "/bls/employment_situation/confidence_intervals": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "CES Analytical Tables A-C2 \u2014 90% confidence intervals for employment, hours, and earnings.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.confidence_intervals(provider='bls')\nobb.bls.employment_situation.confidence_intervals(provider='bls', ci_table='A')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "ci_table", + "type": "str | None", + "description": "Restrict results to one confidence-interval table; None returns all.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All tables", + "value": null + }, + { + "label": "A \u2014 Employment", + "value": "A" + }, + { + "label": "B1 \u2014 Hours & Earnings (All employees)", + "value": "B1" + }, + { + "label": "B2 \u2014 Hours & Earnings (Production employees)", + "value": "B2" + }, + { + "label": "C1 \u2014 Overtime (All employees)", + "value": "C1" + }, + { + "label": "C2 \u2014 Overtime (Production employees)", + "value": "C2" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsCesConfidenceIntervals", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "ci_table", + "type": "str | None", + "description": "Confidence-interval sub-table (A, B1, B2, C1, C2).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "CI Table" + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Measure the interval applies to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Measure" + } + } + }, + { + "name": "employee_group", + "type": "str | None", + "description": "Employee coverage (all vs. production employees).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employee Group" + } + } + }, + { + "name": "indent_level", + "type": "int | None", + "description": "Hierarchy depth.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Level" + } + } + }, + { + "name": "ci_1month_first", + "type": "float | None", + "description": "90% CI for the 1-month change, first release.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1M CI (First Release)", + "cellDataType": "number" + } + } + }, + { + "name": "ci_1month_second", + "type": "float | None", + "description": "90% CI for the 1-month change, second release (Table A only).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1M CI (Second Release)", + "cellDataType": "number" + } + } + }, + { + "name": "ci_1month_third", + "type": "float | None", + "description": "90% CI for the 1-month change, third release (Table A only).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1M CI (Third Release)", + "cellDataType": "number" + } + } + }, + { + "name": "ci_3month", + "type": "float | None", + "description": "90% CI for the 3-month change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3M CI", + "cellDataType": "number" + } + } + }, + { + "name": "ci_6month", + "type": "float | None", + "description": "90% CI for the 6-month change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6M CI", + "cellDataType": "number" + } + } + }, + { + "name": "ci_12month", + "type": "float | None", + "description": "90% CI for the 12-month change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12M CI", + "cellDataType": "number" + } + } + }, + { + "name": "reference_date", + "type": "date | None", + "description": "Reference month the release covers (first of month).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference Month" + } + } + }, + { + "name": "label", + "type": "str | None", + "description": "BLS industry title.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry" + } + } + }, + { + "name": "row_index", + "type": "int | None", + "description": "Sequential ordering index preserving BLS hierarchy.", + "default": 0, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable identifier for the source table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Full BLS table title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsCesConfidenceIntervals", + "openapi_extra": { + "model": "BlsCesConfidenceIntervals" + } + }, + "/bls/employment_situation/civilian_unemployment_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Civilian Unemployment Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.civilian_unemployment_rate(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitCivilianUnemploymentRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "men_20_over", + "type": "float | None", + "description": "Men, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Men, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "women_20_over", + "type": "float | None", + "description": "Women, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Women, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "age_16_19", + "type": "float | None", + "description": "16 to 19 years old.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "16 to 19 years old", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "white", + "type": "float | None", + "description": "White.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "White", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "black", + "type": "float | None", + "description": "Black or African American.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Black or African American", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "asian", + "type": "float | None", + "description": "Asian.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Asian", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hispanic", + "type": "float | None", + "description": "Hispanic or Latino.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hispanic or Latino", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitCivilianUnemploymentRate", + "openapi_extra": { + "model": "BlsEmpsitCivilianUnemploymentRate" + } + }, + "/bls/employment_situation/civilian_unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Civilian Unemployment (Level).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.civilian_unemployment(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitCivilianUnemployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "men_20_over", + "type": "float | None", + "description": "Men, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Men, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "women_20_over", + "type": "float | None", + "description": "Women, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Women, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "age_16_19", + "type": "float | None", + "description": "16 to 19 years old.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "16 to 19 years old", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "white", + "type": "float | None", + "description": "White.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "White", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "black", + "type": "float | None", + "description": "Black or African American.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Black or African American", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "asian", + "type": "float | None", + "description": "Asian.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Asian", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hispanic", + "type": "float | None", + "description": "Hispanic or Latino.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hispanic or Latino", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitCivilianUnemployment", + "openapi_extra": { + "model": "BlsEmpsitCivilianUnemployment" + } + }, + "/bls/employment_situation/unemployment_by_education": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Unemployment Rates by Educational Attainment (25+).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.unemployment_by_education(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitUnemploymentByEducation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "less_than_high_school", + "type": "float | None", + "description": "Less than a high school diploma.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Less than a high school diploma", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "high_school_no_college", + "type": "float | None", + "description": "High school graduates, no college.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High school graduates, no college", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "some_college", + "type": "float | None", + "description": "Some college or associate degree.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Some college or associate degree", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "bachelors_or_higher", + "type": "float | None", + "description": "Bachelor's degree and higher.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bachelor's degree and higher", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitUnemploymentByEducation", + "openapi_extra": { + "model": "BlsEmpsitUnemploymentByEducation" + } + }, + "/bls/employment_situation/unemployment_by_veteran_status": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Unemployment Rates by Veteran Status (18+).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.unemployment_by_veteran_status(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitUnemploymentByVeteranStatus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_veterans", + "type": "float | None", + "description": "Total veterans.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total veterans", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "veteran_men", + "type": "float | None", + "description": "Veteran men.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Veteran men", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "veteran_women", + "type": "float | None", + "description": "Veteran women.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Veteran women", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "gulf_war_era_1", + "type": "float | None", + "description": "Gulf War-era I veterans.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gulf War-era I veterans", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "gulf_war_era_2", + "type": "float | None", + "description": "Gulf War-era II veterans.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gulf War-era II veterans", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wwii_korea_vietnam", + "type": "float | None", + "description": "World War II, Korean War, and Vietnam-era veterans.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "World War II, Korean War, and Vietnam-era veterans", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "other_service_veterans", + "type": "float | None", + "description": "Veterans of other service periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Veterans of other service periods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "total_nonveterans", + "type": "float | None", + "description": "Total nonveterans.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonveterans", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonveteran_men", + "type": "float | None", + "description": "Nonveteran men.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonveteran men", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonveteran_women", + "type": "float | None", + "description": "Nonveteran women.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonveteran women", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitUnemploymentByVeteranStatus", + "openapi_extra": { + "model": "BlsEmpsitUnemploymentByVeteranStatus" + } + }, + "/bls/employment_situation/reasons_for_unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Reasons for Unemployment.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.reasons_for_unemployment(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitReasonsForUnemployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "job_losers_and_completed_temp", + "type": "float | None", + "description": "Job losers and people who completed temporary jobs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Job losers and people who completed temporary jobs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "job_losers_not_on_layoff", + "type": "float | None", + "description": "Job losers not on temporary layoff.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Job losers not on temporary layoff", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "job_losers_on_temp_layoff", + "type": "float | None", + "description": "Job losers on temporary layoff.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Job losers on temporary layoff", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "job_leavers", + "type": "float | None", + "description": "Job leavers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Job leavers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "reentrants", + "type": "float | None", + "description": "Reentrants.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reentrants", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "new_entrants", + "type": "float | None", + "description": "New entrants.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New entrants", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitReasonsForUnemployment", + "openapi_extra": { + "model": "BlsEmpsitReasonsForUnemployment" + } + }, + "/bls/employment_situation/duration_of_unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Duration of Unemployment.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.duration_of_unemployment(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitDurationOfUnemployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "less_than_5_weeks", + "type": "float | None", + "description": "Less than 5 weeks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Less than 5 weeks", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "weeks_5_to_14", + "type": "float | None", + "description": "5-14 weeks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "5-14 weeks", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "weeks_15_to_26", + "type": "float | None", + "description": "15-26 weeks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15-26 weeks", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "weeks_27_and_over", + "type": "float | None", + "description": "27 weeks and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "27 weeks and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitDurationOfUnemployment", + "openapi_extra": { + "model": "BlsEmpsitDurationOfUnemployment" + } + }, + "/bls/employment_situation/long_term_unemployed_share": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Unemployed 27 Weeks or Longer as a Percent of Total Unemployed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.long_term_unemployed_share(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitLongTermUnemployedShare", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "percent", + "type": "float | None", + "description": "Percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitLongTermUnemployedShare", + "openapi_extra": { + "model": "BlsEmpsitLongTermUnemployedShare" + } + }, + "/bls/employment_situation/labor_underutilization": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Alternative Measures of Labor Underutilization (U-1 to U-6).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.labor_underutilization(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitLaborUnderutilization", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "u_1", + "type": "float | None", + "description": "U-1, people unemployed 15 weeks or longer, as a percent of the civilian labor force.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U-1, people unemployed 15 weeks or longer, as a percent of the civilian labor force", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "u_2", + "type": "float | None", + "description": "U-2, job losers and people who completed temporary jobs, as a percent of the civilian labor force.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U-2, job losers and people who completed temporary jobs, as a percent of the civilian labor force", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "u_3", + "type": "float | None", + "description": "U-3, total unemployed, as a percent of the civilian labor force (official unemployment rate).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U-3, total unemployed, as a percent of the civilian labor force (official unemployment rate)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "u_4", + "type": "float | None", + "description": "U-4, total unemployed plus discouraged workers, as a percent of the civilian labor force plus discouraged workers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U-4, total unemployed plus discouraged workers, as a percent of the civilian labor force plus discouraged workers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "u_5", + "type": "float | None", + "description": "U-5, total unemployed, plus discouraged workers, plus all other marginally attached workers, as a percent of the civilian labor force plus all marginally attached workers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U-5, total unemployed, plus discouraged workers, plus all other marginally attached workers, as a percent of the civilian labor force plus all marginally attached workers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "u_6", + "type": "float | None", + "description": "U-6, total unemployed, plus all marginally attached workers, plus total employed part time for economic reasons, as a percent of the civilian labor force plus all marginally attached workers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "U-6, total unemployed, plus all marginally attached workers, plus total employed part time for economic reasons, as a percent of the civilian labor force plus all marginally attached workers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitLaborUnderutilization", + "openapi_extra": { + "model": "BlsEmpsitLaborUnderutilization" + } + }, + "/bls/employment_situation/labor_force_participation_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Civilian Labor Force Participation Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.labor_force_participation_rate(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitLaborForceParticipationRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "men_20_over", + "type": "float | None", + "description": "Men, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Men, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "women_20_over", + "type": "float | None", + "description": "Women, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Women, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "age_16_19", + "type": "float | None", + "description": "16 to 19 years old.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "16 to 19 years old", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "white", + "type": "float | None", + "description": "White.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "White", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "black", + "type": "float | None", + "description": "Black or African American.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Black or African American", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "asian", + "type": "float | None", + "description": "Asian.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Asian", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hispanic", + "type": "float | None", + "description": "Hispanic or Latino.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hispanic or Latino", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitLaborForceParticipationRate", + "openapi_extra": { + "model": "BlsEmpsitLaborForceParticipationRate" + } + }, + "/bls/employment_situation/employment_population_ratio": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Employment-Population Ratio.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.employment_population_ratio(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitEmploymentPopulationRatio", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "men_20_over", + "type": "float | None", + "description": "Men, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Men, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "women_20_over", + "type": "float | None", + "description": "Women, 20 years and over.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Women, 20 years and over", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "age_16_19", + "type": "float | None", + "description": "16 to 19 years old.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "16 to 19 years old", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "white", + "type": "float | None", + "description": "White.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "White", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "black", + "type": "float | None", + "description": "Black or African American.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Black or African American", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "asian", + "type": "float | None", + "description": "Asian.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Asian", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hispanic", + "type": "float | None", + "description": "Hispanic or Latino.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hispanic or Latino", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitEmploymentPopulationRatio", + "openapi_extra": { + "model": "BlsEmpsitEmploymentPopulationRatio" + } + }, + "/bls/employment_situation/civilian_employment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Civilian Employment (Level).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.civilian_employment(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitCivilianEmployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total", + "type": "float | None", + "description": "Total.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonag_wage_and_salary", + "type": "float | None", + "description": "Nonagricultural wage and salary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonagricultural wage and salary", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonag_self_employment", + "type": "float | None", + "description": "Nonagricultural self-employment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonagricultural self-employment", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "employed_part_time", + "type": "float | None", + "description": "Employed part time.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employed part time", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitCivilianEmployment", + "openapi_extra": { + "model": "BlsEmpsitCivilianEmployment" + } + }, + "/bls/employment_situation/not_in_labor_force_want_a_job": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 People Not in the Labor Force Who Want a Job.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.not_in_labor_force_want_a_job(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitNotInLaborForceWantAJob", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "thousands", + "type": "float | None", + "description": "Thousands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thousands", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitNotInLaborForceWantAJob", + "openapi_extra": { + "model": "BlsEmpsitNotInLaborForceWantAJob" + } + }, + "/bls/employment_situation/not_in_labor_force_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 People Not in the Labor Force, Selected Indicators.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.not_in_labor_force_indicators(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitNotInLaborForceIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "marginally_attached", + "type": "float | None", + "description": "Marginally attached.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Marginally attached", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "discouraged", + "type": "float | None", + "description": "Discouraged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Discouraged", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitNotInLaborForceIndicators", + "openapi_extra": { + "model": "BlsEmpsitNotInLaborForceIndicators" + } + }, + "/bls/employment_situation/employment_levels_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Employment Levels by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.employment_levels_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitEmploymentLevelsByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_nonfarm", + "type": "float | None", + "description": "Total nonfarm.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total nonfarm", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "total_private", + "type": "float | None", + "description": "Total private.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total private", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "mining_and_logging", + "type": "float | None", + "description": "Mining and logging.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining and logging", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "construction", + "type": "float | None", + "description": "Construction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Construction", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "manufacturing", + "type": "float | None", + "description": "Manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wholesale_trade", + "type": "float | None", + "description": "Wholesale trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade", + "type": "float | None", + "description": "Retail trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_and_warehousing", + "type": "float | None", + "description": "Transportation and warehousing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation and warehousing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "utilities", + "type": "float | None", + "description": "Utilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Utilities", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "information", + "type": "float | None", + "description": "Information.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Information", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "financial_activities", + "type": "float | None", + "description": "Financial activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Financial activities", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "professional_and_business_services", + "type": "float | None", + "description": "Professional and business services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Professional and business services", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "private_education_and_health_services", + "type": "float | None", + "description": "Private education and health services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Private education and health services", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leisure_and_hospitality", + "type": "float | None", + "description": "Leisure and hospitality.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leisure and hospitality", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "other_services", + "type": "float | None", + "description": "Other services.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other services", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "government", + "type": "float | None", + "description": "Government.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "federal_government", + "type": "float | None", + "description": "Federal government.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Federal government", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "state_government", + "type": "float | None", + "description": "State government.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State government", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "local_government", + "type": "float | None", + "description": "Local government.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Local government", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitEmploymentLevelsByIndustry", + "openapi_extra": { + "model": "BlsEmpsitEmploymentLevelsByIndustry" + } + }, + "/bls/employment_situation/average_weekly_hours_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Average Weekly Hours of Production Employees in Manufacturing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.average_weekly_hours_production(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitAverageWeeklyHoursProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "manufacturing", + "type": "float | None", + "description": "Manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "durable_goods", + "type": "float | None", + "description": "Durable goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Durable goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_product", + "type": "float | None", + "description": "Wood product manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood product manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral", + "type": "float | None", + "description": "Nonmetallic mineral product manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral product manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metal", + "type": "float | None", + "description": "Primary metal manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metal manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal", + "type": "float | None", + "description": "Fabricated metal product manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal product manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery", + "type": "float | None", + "description": "Machinery manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_electronic", + "type": "float | None", + "description": "Computer and electronic product manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic product manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment", + "type": "float | None", + "description": "Electrical equipment, appliance, and component manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment, appliance, and component manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment", + "type": "float | None", + "description": "Transportation equipment manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture", + "type": "float | None", + "description": "Furniture and related product manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related product manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous", + "type": "float | None", + "description": "Miscellaneous manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nondurable_goods", + "type": "float | None", + "description": "Nondurable goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nondurable goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills", + "type": "float | None", + "description": "Textile product mills.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper", + "type": "float | None", + "description": "Paper manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing", + "type": "float | None", + "description": "Printing and related support activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemical", + "type": "float | None", + "description": "Chemical manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemical manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber", + "type": "float | None", + "description": "Plastics and rubber products manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products manufacturing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitAverageWeeklyHoursProduction", + "openapi_extra": { + "model": "BlsEmpsitAverageWeeklyHoursProduction" + } + }, + "/bls/employment_situation/employment_change_by_industry_ci": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Employment Change by Industry With Confidence Intervals.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.employment_change_by_industry_ci(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitEmploymentChangeByIndustryCi", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "net_change_1month", + "type": "float | None", + "description": "1-month net change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1-month net change", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "ci_1month", + "type": "float | None", + "description": "1-month 90-percent confidence interval.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1-month 90-percent confidence interval", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "net_change_3month", + "type": "float | None", + "description": "3-month net change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3-month net change", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "ci_3month", + "type": "float | None", + "description": "3-month 90-percent confidence interval.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3-month 90-percent confidence interval", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "net_change_6month", + "type": "float | None", + "description": "6-month net change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6-month net change", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "ci_6month", + "type": "float | None", + "description": "6-month 90-percent confidence interval.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6-month 90-percent confidence interval", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "net_change_12month", + "type": "float | None", + "description": "12-month net change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12-month net change", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "ci_12month", + "type": "float | None", + "description": "12-month 90-percent confidence interval.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12-month 90-percent confidence interval", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry / supersector.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitEmploymentChangeByIndustryCi", + "openapi_extra": { + "model": "BlsEmpsitEmploymentChangeByIndustryCi" + } + }, + "/bls/employment_situation/employment_by_industry_monthly_changes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Employment by Industry, Monthly Changes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.employment_by_industry_monthly_changes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitEmploymentByIndustryMonthlyChanges", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "employed", + "type": "float | None", + "description": "Employed (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employed (thousands)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "net_change_1month", + "type": "float | None", + "description": "1-month net change (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1-month net change (thousands)", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_1month", + "type": "float | None", + "description": "1-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "net_change_3month", + "type": "float | None", + "description": "3-month net change (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3-month net change (thousands)", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_3month", + "type": "float | None", + "description": "3-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "net_change_6month", + "type": "float | None", + "description": "6-month net change (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6-month net change (thousands)", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_6month", + "type": "float | None", + "description": "6-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "net_change_12month", + "type": "float | None", + "description": "12-month net change (thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12-month net change (thousands)", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "pct_change_12month", + "type": "float | None", + "description": "12-month percent change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12-month percent change", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry / supersector.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitEmploymentByIndustryMonthlyChanges", + "openapi_extra": { + "model": "BlsEmpsitEmploymentByIndustryMonthlyChanges" + } + }, + "/bls/employment_situation/employment_and_hourly_earnings_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Employment and Average Hourly Earnings by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.employment_and_hourly_earnings_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitEmploymentAndHourlyEarningsByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "otm_change_employment", + "type": "float | None", + "description": "Over-the-month-change in employment (in thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Over-the-month-change in employment (in thousands)", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "average_hourly_earnings", + "type": "float | None", + "description": "Average hourly earnings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Average hourly earnings", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "employment_level", + "type": "float | None", + "description": "Employment level (in thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment level (in thousands)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry / supersector.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitEmploymentAndHourlyEarningsByIndustry", + "openapi_extra": { + "model": "BlsEmpsitEmploymentAndHourlyEarningsByIndustry" + } + }, + "/bls/employment_situation/employment_and_weekly_earnings_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Employment Situation chart \u2014 Employment and Average Weekly Earnings by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.employment_situation.employment_and_weekly_earnings_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEmpsitEmploymentAndWeeklyEarningsByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "otm_change_employment", + "type": "float | None", + "description": "Over-the-month-change in employment (in thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Over-the-month-change in employment (in thousands)", + "cellDataType": "number", + "chartDataType": "series", + "renderFn": "greenRed" + } + } + }, + { + "name": "average_weekly_earnings", + "type": "float | None", + "description": "Average weekly earnings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Average weekly earnings", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "employment_level", + "type": "float | None", + "description": "Employment level (in thousands).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment level (in thousands)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry / supersector.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsEmpsitEmploymentAndWeeklyEarningsByIndustry", + "openapi_extra": { + "model": "BlsEmpsitEmploymentAndWeeklyEarningsByIndustry" + } + }, + "/bls/productivity/tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch a BLS Productivity prod2 supplemental table in long form (every column preserved).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Quarterly Nonfarm business sector labor productivity (the default headline series).\nobb.bls.productivity.tables(provider='bls')\n# Manufacturing sector unit labor costs, quarterly.\nobb.bls.productivity.tables(provider='bls', sector='Manufacturing sector', measure='Unit labor costs')\n# Total economy hours worked, in billions of hours.\nobb.bls.productivity.tables(provider='bls', dataset='total-economy-hours-employment', sector='Total economy', measure='Hours worked', units='Billions of hours')\n# Nonfarm business labor productivity growth by business cycle.\nobb.bls.productivity.tables(provider='bls', dataset='major-sectors-business-cycles', units='Compound annual growth rate')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "dataset", + "type": "str | None", + "description": "Productivity supplemental dataset to load.", + "default": "major-sectors-quarterly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "major-sectors-quarterly \u2014 Quarterly labor productivity and related measures, major sectors.", + "value": "major-sectors-quarterly" + }, + { + "label": "major-sectors-annual \u2014 Annual labor productivity and related measures, major sectors.", + "value": "major-sectors-annual" + }, + { + "label": "major-sectors-business-cycles \u2014 Labor productivity major sectors, compound annual growth rates by approximate business cycle period.", + "value": "major-sectors-business-cycles" + }, + { + "label": "total-economy-hours-employment \u2014 Quarterly hours worked and employment, total U.S. economy and subsectors.", + "value": "total-economy-hours-employment" + } + ], + "style": { + "popupWidth": 950 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector to restrict the results. Defaults to the headline Nonfarm business sector; clear it to load every sector.", + "default": "Nonfarm business sector", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Nonfarm business sector", + "value": "Nonfarm business sector" + }, + { + "label": "Business sector", + "value": "Business sector" + }, + { + "label": "Nonfinancial corporate sector", + "value": "Nonfinancial corporate sector" + }, + { + "label": "Manufacturing sector", + "value": "Manufacturing sector" + }, + { + "label": "Durable manufacturing sector", + "value": "Durable manufacturing sector" + }, + { + "label": "Nondurable manufacturing sector", + "value": "Nondurable manufacturing sector" + }, + { + "label": "Total economy", + "value": "Total economy" + } + ], + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Measure to restrict the results. Defaults to Labor productivity; clear it to load every measure.", + "default": "Labor productivity", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Labor productivity", + "value": "Labor productivity" + }, + { + "label": "Output per worker", + "value": "Output per worker" + }, + { + "label": "Sectoral output", + "value": "Sectoral output" + }, + { + "label": "Real sectoral output", + "value": "Real sectoral output" + }, + { + "label": "Value-added output", + "value": "Value-added output" + }, + { + "label": "Real value-added output", + "value": "Real value-added output" + }, + { + "label": "Hours worked", + "value": "Hours worked" + }, + { + "label": "Employment", + "value": "Employment" + }, + { + "label": "Average weekly hours", + "value": "Average weekly hours" + }, + { + "label": "Labor compensation", + "value": "Labor compensation" + }, + { + "label": "Hourly compensation", + "value": "Hourly compensation" + }, + { + "label": "Real hourly compensation", + "value": "Real hourly compensation" + }, + { + "label": "Unit labor costs", + "value": "Unit labor costs" + }, + { + "label": "Unit nonlabor costs", + "value": "Unit nonlabor costs" + }, + { + "label": "Unit nonlabor payments", + "value": "Unit nonlabor payments" + }, + { + "label": "Unit combined input costs", + "value": "Unit combined input costs" + }, + { + "label": "Unit profits", + "value": "Unit profits" + }, + { + "label": "Nonlabor costs", + "value": "Nonlabor costs" + }, + { + "label": "Nonlabor payments", + "value": "Nonlabor payments" + }, + { + "label": "Labor share", + "value": "Labor share" + }, + { + "label": "Profits", + "value": "Profits" + }, + { + "label": "Consumer price deflator", + "value": "Consumer price deflator" + }, + { + "label": "Sectoral output price deflator", + "value": "Sectoral output price deflator" + }, + { + "label": "Value-added output price deflator", + "value": "Value-added output price deflator" + } + ], + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "Units to restrict the results. Defaults to the 2017=100 index (one row per period); clear it to load every units basis. The source is long-form, so leaving every dimension open returns one row per sector / measure / units / period.", + "default": "Index (2017=100)", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Index (2017=100)", + "value": "Index (2017=100)" + }, + { + "label": "Index", + "value": "Index" + }, + { + "label": "% Change from previous quarter", + "value": "% Change from previous quarter" + }, + { + "label": "% Change from previous year", + "value": "% Change from previous year" + }, + { + "label": "% Change same quarter 1 year ago", + "value": "% Change same quarter 1 year ago" + }, + { + "label": "Compound annual growth rate", + "value": "Compound annual growth rate" + }, + { + "label": "Billions of current dollars", + "value": "Billions of current dollars" + }, + { + "label": "Billions of hours", + "value": "Billions of hours" + }, + { + "label": "Millions of jobs", + "value": "Millions of jobs" + }, + { + "label": "Current dollars per hour worked", + "value": "Current dollars per hour worked" + }, + { + "label": "CPI-adjusted dollars per hour worked", + "value": "CPI-adjusted dollars per hour worked" + }, + { + "label": "Hours worked per job per week", + "value": "Hours worked per job per week" + }, + { + "label": "Percentage", + "value": "Percentage" + }, + { + "label": "Level - not available", + "value": "Level - not available" + } + ], + "style": { + "popupWidth": 350 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityTables", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "date", + "type": "date | None | str", + "description": "First-of-period date the observation applies to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "period_kind", + "type": "str", + "description": "Period kind for the row (quarter, annual, or business cycle).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "year", + "type": "int | None", + "description": "Year reported in the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "quarter", + "type": "int | str | None", + "description": "Quarter index reported in the source XLSX.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "sector", + "type": "str | None", + "description": "BLS sector this row belongs to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "basis", + "type": "str | None", + "description": "Worker-counting basis used for the row.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "component", + "type": "str | None", + "description": "Sub-sector component for the total-economy workbook.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "measure", + "type": "str", + "description": "Productivity measure being reported.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "units", + "type": "str", + "description": "Units the value is expressed in.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "value", + "type": "float | None", + "description": "Numeric observation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "value_string", + "type": "str | None", + "description": "Raw cell text when the value isn't numeric.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "cycle_period", + "type": "str | None", + "description": "Business-cycle period label as published by BLS.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "cycle_start_date", + "type": "date | None", + "description": "First-of-quarter start date for the business-cycle period.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "cycle_end_date", + "type": "date | None", + "description": "First-of-quarter end date for the business-cycle period.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "row_index", + "type": "int", + "description": "Sequential parser order preserving the source layout.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Stable dataset identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_title", + "type": "str", + "description": "Human-readable dataset title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "source_file", + "type": "str", + "description": "Filename of the source XLSX on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "release_date", + "type": "date | None", + "description": "Release date stamped in the workbook header.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsProductivityTables", + "openapi_extra": { + "model": "BlsProductivityTables" + } + }, + "/bls/productivity/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List BLS Productivity release PDFs and supplemental XLSX files for the file viewer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All current Productivity release PDFs.\nobb.bls.productivity.documents(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Family of BLS Productivity PDFs to enumerate.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All documents", + "value": "all" + }, + { + "label": "Labor Productivity (current release PDFs)", + "value": "labor_productivity" + }, + { + "label": "Total Factor Productivity (current release PDFs)", + "value": "total_factor_productivity" + }, + { + "label": "Archived releases (historical PDFs)", + "value": "archived" + } + ] + } + } + }, + { + "name": "release_code", + "type": "str | None", + "description": "Optional release code to restrict the results.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest publication date to include (inclusive).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest publication date to include (inclusive).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "BLS-published headline of the release PDF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the PDF on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "release_code", + "type": "str | None", + "description": "Source release identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Publication date of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format of the document.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsProductivityDocuments", + "openapi_extra": { + "model": "BlsProductivityDocuments" + } + }, + "/bls/productivity/by_sector": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Productivity and Costs by Sector.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.by_sector(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityBySector", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "business", + "type": "float | None", + "description": "Business.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Business", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "nonfarm_business", + "type": "float | None", + "description": "Nonfarm business.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonfarm business", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "manufacturing", + "type": "float | None", + "description": "Manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Manufacturing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "durable_goods", + "type": "float | None", + "description": "Durable goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Durable goods", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "nondurable_goods", + "type": "float | None", + "description": "Nondurable goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nondurable goods", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "measure", + "type": "str", + "description": "Productivity measure.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Measure", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityBySector", + "openapi_extra": { + "model": "BlsProductivityBySector" + } + }, + "/bls/productivity/nonfarm_business_productivity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Labor Productivity, Nonfarm Business \u2014 Percent Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.nonfarm_business_productivity(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityNonfarmBusinessProductivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_from_previous_quarter", + "type": "float | None", + "description": "Percent change from previous quarter (annual rate).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from previous quarter (annual rate)", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_from_year_ago", + "type": "float | None", + "description": "Percent change from same quarter a year ago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from same quarter a year ago", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityNonfarmBusinessProductivity", + "openapi_extra": { + "model": "BlsProductivityNonfarmBusinessProductivity" + } + }, + "/bls/productivity/nonfarm_business_labor_costs": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Unit Labor Costs, Nonfarm Business \u2014 Percent Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.nonfarm_business_labor_costs(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityNonfarmBusinessLaborCosts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_from_previous_quarter", + "type": "float | None", + "description": "Percent change from previous quarter (annual rate).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from previous quarter (annual rate)", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_from_year_ago", + "type": "float | None", + "description": "Percent change from same quarter a year ago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from same quarter a year ago", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityNonfarmBusinessLaborCosts", + "openapi_extra": { + "model": "BlsProductivityNonfarmBusinessLaborCosts" + } + }, + "/bls/productivity/manufacturing_productivity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Labor Productivity, Manufacturing \u2014 Percent Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.manufacturing_productivity(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityManufacturingProductivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_from_previous_quarter", + "type": "float | None", + "description": "Percent change from previous quarter (annual rate).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from previous quarter (annual rate)", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_from_year_ago", + "type": "float | None", + "description": "Percent change from same quarter a year ago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from same quarter a year ago", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityManufacturingProductivity", + "openapi_extra": { + "model": "BlsProductivityManufacturingProductivity" + } + }, + "/bls/productivity/manufacturing_labor_costs": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Unit Labor Costs, Manufacturing \u2014 Percent Change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.manufacturing_labor_costs(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityManufacturingLaborCosts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "change_from_previous_quarter", + "type": "float | None", + "description": "Percent change from previous quarter (annual rate).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from previous quarter (annual rate)", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "change_from_year_ago", + "type": "float | None", + "description": "Percent change from same quarter a year ago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent change from same quarter a year ago", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityManufacturingLaborCosts", + "openapi_extra": { + "model": "BlsProductivityManufacturingLaborCosts" + } + }, + "/bls/productivity/nonfarm_business_indexes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Productivity, Output, and Hours Indexes \u2014 Nonfarm Business (2017=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.nonfarm_business_indexes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityNonfarmBusinessIndexes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hours_worked", + "type": "float | None", + "description": "Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "labor_productivity", + "type": "float | None", + "description": "Labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityNonfarmBusinessIndexes", + "openapi_extra": { + "model": "BlsProductivityNonfarmBusinessIndexes" + } + }, + "/bls/productivity/manufacturing_indexes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Productivity, Output, and Hours Indexes \u2014 Manufacturing (2017=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.manufacturing_indexes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityManufacturingIndexes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hours_worked", + "type": "float | None", + "description": "Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "labor_productivity", + "type": "float | None", + "description": "Labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityManufacturingIndexes", + "openapi_extra": { + "model": "BlsProductivityManufacturingIndexes" + } + }, + "/bls/productivity/nonfinancial_corporations_indexes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Productivity, Output, and Hours Indexes \u2014 Nonfinancial Corporations (2017=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.nonfinancial_corporations_indexes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsProductivityNonfinancialCorporationsIndexes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hours_worked", + "type": "float | None", + "description": "Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "labor_productivity", + "type": "float | None", + "description": "Labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation quarter (first of quarter).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quarter", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsProductivityNonfinancialCorporationsIndexes", + "openapi_extra": { + "model": "BlsProductivityNonfinancialCorporationsIndexes" + } + }, + "/bls/productivity/tfp_combined_inputs_output": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Combined Inputs and Output \u2014 % Change by Industry (Latest Year).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.tfp_combined_inputs_output(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsTfpCombinedInputsOutput", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_factor_productivity", + "type": "float | None", + "description": "Total Factor Productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total Factor Productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "combined_inputs", + "type": "float | None", + "description": "Combined Inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Combined Inputs", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsTfpCombinedInputsOutput", + "openapi_extra": { + "model": "BlsTfpCombinedInputsOutput" + } + }, + "/bls/productivity/tfp_percent_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Total Factor Productivity \u2014 % Change by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.tfp_percent_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsTfpPercentChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "y2023", + "type": "float | None", + "description": "2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "y2024", + "type": "float | None", + "description": "2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsTfpPercentChange", + "openapi_extra": { + "model": "BlsTfpPercentChange" + } + }, + "/bls/productivity/tfp_output_and_inputs": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Output and Inputs \u2014 % Change by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.tfp_output_and_inputs(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsTfpOutputAndInputs", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_factor_productivity_2023", + "type": "float | None", + "description": "Total Factor Productivity, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total Factor Productivity, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "total_factor_productivity_2024", + "type": "float | None", + "description": "Total Factor Productivity, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total Factor Productivity, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "sectoral_output_2023", + "type": "float | None", + "description": "Sectoral Output, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sectoral Output, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "sectoral_output_2024", + "type": "float | None", + "description": "Sectoral Output, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sectoral Output, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "combined_inputs_2023", + "type": "float | None", + "description": "Combined Inputs, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Combined Inputs, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "combined_inputs_2024", + "type": "float | None", + "description": "Combined Inputs, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Combined Inputs, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "capital_input_2023", + "type": "float | None", + "description": "Capital Input, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Capital Input, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "capital_input_2024", + "type": "float | None", + "description": "Capital Input, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Capital Input, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "labor_input_2023", + "type": "float | None", + "description": "Labor Input, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Labor Input, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "labor_input_2024", + "type": "float | None", + "description": "Labor Input, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Labor Input, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy_input_2023", + "type": "float | None", + "description": "Energy Input, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy Input, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "energy_input_2024", + "type": "float | None", + "description": "Energy Input, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy Input, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "materials_input_2023", + "type": "float | None", + "description": "Materials Input, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Materials Input, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "materials_input_2024", + "type": "float | None", + "description": "Materials Input, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Materials Input, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services_input_2023", + "type": "float | None", + "description": "Services Input, 2023.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services Input, 2023", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "services_input_2024", + "type": "float | None", + "description": "Services Input, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services Input, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsTfpOutputAndInputs", + "openapi_extra": { + "model": "BlsTfpOutputAndInputs" + } + }, + "/bls/productivity/tfp_contributions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Contributions to Labor Productivity \u2014 % Change by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.tfp_contributions(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsTfpContributions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "total_factor_productivity", + "type": "float | None", + "description": "Total Factor Productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total Factor Productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "contribution_of_labor_composition_to_labor_productivity", + "type": "float | None", + "description": "Contribution of labor composition to labor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Contribution of labor composition to labor productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "contribution_of_capital_intensity_to_labor_productivity", + "type": "float | None", + "description": "Contribution of capital intensity to labor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Contribution of capital intensity to labor productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "contribution_of_energy_intensity_to_labor_productivity", + "type": "float | None", + "description": "Contribution of energy intensity to labor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Contribution of energy intensity to labor productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "contribution_of_materials_intensity_to_labor_productivity", + "type": "float | None", + "description": "Contribution of materials intensity to labor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Contribution of materials intensity to labor productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "contribution_of_services_intensity_to_labor_productivity", + "type": "float | None", + "description": "Contribution of services intensity to labor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Contribution of services intensity to labor productivity", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsTfpContributions", + "openapi_extra": { + "model": "BlsTfpContributions" + } + }, + "/bls/productivity/tfp_ict_trends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 ICT Industries \u2014 TFP, Inputs, and Output Index Trends.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.tfp_ict_trends(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsTfpIctTrends", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "information_total_factor_productivity", + "type": "float | None", + "description": "Information, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Information, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "information_combined_inputs", + "type": "float | None", + "description": "Information, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Information, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "information_real_output", + "type": "float | None", + "description": "Information, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Information, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "broadcasting_and_telecommunications_total_factor_productivity", + "type": "float | None", + "description": "Broadcasting and telecommunications, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Broadcasting and telecommunications, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "broadcasting_and_telecommunications_combined_inputs", + "type": "float | None", + "description": "Broadcasting and telecommunications, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Broadcasting and telecommunications, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "broadcasting_and_telecommunications_real_output", + "type": "float | None", + "description": "Broadcasting and telecommunications, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Broadcasting and telecommunications, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_systems_design_and_related_services_total_factor_productivity", + "type": "float | None", + "description": "Computer systems design and related services, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer systems design and related services, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_systems_design_and_related_services_combined_inputs", + "type": "float | None", + "description": "Computer systems design and related services, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer systems design and related services, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_systems_design_and_related_services_real_output", + "type": "float | None", + "description": "Computer systems design and related services, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer systems design and related services, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_total_factor_productivity", + "type": "float | None", + "description": "Computer and electronic products, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_combined_inputs", + "type": "float | None", + "description": "Computer and electronic products, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_real_output", + "type": "float | None", + "description": "Computer and electronic products, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "data_processing_internet_publishing_and_other_information_services_total_factor_productivity", + "type": "float | None", + "description": "Data processing, internet publishing, and other information services, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Data processing, internet publishing, and other information services, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "data_processing_internet_publishing_and_other_information_services_combined_inputs", + "type": "float | None", + "description": "Data processing, internet publishing, and other information services, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Data processing, internet publishing, and other information services, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "data_processing_internet_publishing_and_other_information_services_real_output", + "type": "float | None", + "description": "Data processing, internet publishing, and other information services, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Data processing, internet publishing, and other information services, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsTfpIctTrends", + "openapi_extra": { + "model": "BlsTfpIctTrends" + } + }, + "/bls/productivity/tfp_fire_trends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Finance, Insurance, and Real Estate Industries \u2014 TFP, Inputs, and Output Index Trends.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.tfp_fire_trends(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsTfpFireTrends", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "finance_insurance_and_real_estate_total_factor_productivity", + "type": "float | None", + "description": "Finance, insurance, and real estate, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance, insurance, and real estate, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "finance_insurance_and_real_estate_combined_inputs", + "type": "float | None", + "description": "Finance, insurance, and real estate, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance, insurance, and real estate, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "finance_insurance_and_real_estate_real_output", + "type": "float | None", + "description": "Finance, insurance, and real estate, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance, insurance, and real estate, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "finance_and_insurance_total_factor_productivity", + "type": "float | None", + "description": "Finance and insurance, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance and insurance, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "finance_and_insurance_combined_inputs", + "type": "float | None", + "description": "Finance and insurance, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance and insurance, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "finance_and_insurance_real_output", + "type": "float | None", + "description": "Finance and insurance, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finance and insurance, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "federal_reserve_banks_credit_intermediation_and_related_activities_total_factor_productivity", + "type": "float | None", + "description": "Federal Reserve banks, credit intermediation, and related activities, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Federal Reserve banks, credit intermediation, and related activities, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "federal_reserve_banks_credit_intermediation_and_related_activities_combined_inputs", + "type": "float | None", + "description": "Federal Reserve banks, credit intermediation, and related activities, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Federal Reserve banks, credit intermediation, and related activities, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "federal_reserve_banks_credit_intermediation_and_related_activities_real_output", + "type": "float | None", + "description": "Federal Reserve banks, credit intermediation, and related activities, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Federal Reserve banks, credit intermediation, and related activities, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "securities_commodity_contracts_and_investments_total_factor_productivity", + "type": "float | None", + "description": "Securities, commodity contracts, and investments, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Securities, commodity contracts, and investments, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "securities_commodity_contracts_and_investments_combined_inputs", + "type": "float | None", + "description": "Securities, commodity contracts, and investments, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Securities, commodity contracts, and investments, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "securities_commodity_contracts_and_investments_real_output", + "type": "float | None", + "description": "Securities, commodity contracts, and investments, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Securities, commodity contracts, and investments, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "insurance_carriers_and_related_activities_total_factor_productivity", + "type": "float | None", + "description": "Insurance carriers and related activities, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Insurance carriers and related activities, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "insurance_carriers_and_related_activities_combined_inputs", + "type": "float | None", + "description": "Insurance carriers and related activities, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Insurance carriers and related activities, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "insurance_carriers_and_related_activities_real_output", + "type": "float | None", + "description": "Insurance carriers and related activities, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Insurance carriers and related activities, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "funds_trusts_and_other_financial_vehicles_total_factor_productivity", + "type": "float | None", + "description": "Funds, trusts, and other financial vehicles, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Funds, trusts, and other financial vehicles, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "funds_trusts_and_other_financial_vehicles_combined_inputs", + "type": "float | None", + "description": "Funds, trusts, and other financial vehicles, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Funds, trusts, and other financial vehicles, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "funds_trusts_and_other_financial_vehicles_real_output", + "type": "float | None", + "description": "Funds, trusts, and other financial vehicles, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Funds, trusts, and other financial vehicles, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "real_estate_and_rental_and_leasing_total_factor_productivity", + "type": "float | None", + "description": "Real estate and rental and leasing, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate and rental and leasing, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "real_estate_and_rental_and_leasing_combined_inputs", + "type": "float | None", + "description": "Real estate and rental and leasing, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate and rental and leasing, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "real_estate_and_rental_and_leasing_real_output", + "type": "float | None", + "description": "Real estate and rental and leasing, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate and rental and leasing, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "real_estate_total_factor_productivity", + "type": "float | None", + "description": "Real estate, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "real_estate_combined_inputs", + "type": "float | None", + "description": "Real estate, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "real_estate_real_output", + "type": "float | None", + "description": "Real estate, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Real estate, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "rental_and_leasing_services_and_lessors_of_intangible_assets_total_factor_productivity", + "type": "float | None", + "description": "Rental and leasing services and lessors of intangible assets, total factor productivity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rental and leasing services and lessors of intangible assets, total factor productivity", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "rental_and_leasing_services_and_lessors_of_intangible_assets_combined_inputs", + "type": "float | None", + "description": "Rental and leasing services and lessors of intangible assets, combined inputs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rental and leasing services and lessors of intangible assets, combined inputs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "rental_and_leasing_services_and_lessors_of_intangible_assets_real_output", + "type": "float | None", + "description": "Rental and leasing services and lessors of intangible assets, real output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rental and leasing services and lessors of intangible assets, real output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsTfpFireTrends", + "openapi_extra": { + "model": "BlsTfpFireTrends" + } + }, + "/bls/productivity/wr_productivity_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Percent Change in Productivity by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_productivity_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWrProductivityChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "productivity_1_year_percent_change_2025", + "type": "float | None", + "description": "Productivity 1-year percent change, 2025.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Productivity 1-year percent change, 2025", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "productivity_annual_percent_change_1987_2025", + "type": "float | None", + "description": "Productivity annual percent change, 1987-2025.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Productivity annual percent change, 1987-2025", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWrProductivityChange", + "openapi_extra": { + "model": "BlsWrProductivityChange" + } + }, + "/bls/productivity/wr_productivity_by_period": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Percent Change in Productivity by Select Periods.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_productivity_by_period(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWrProductivityByPeriod", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "wholesale_trade", + "type": "float | None", + "description": "Wholesale trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "retail_trade", + "type": "float | None", + "description": "Retail trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "period", + "type": "str", + "description": "Period the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWrProductivityByPeriod", + "openapi_extra": { + "model": "BlsWrProductivityByPeriod" + } + }, + "/bls/productivity/wr_indexes_by_sector": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Output, Hours, and Productivity Indexes by Sector (1987=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_indexes_by_sector(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWrIndexesBySector", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "wholesale_trade_output", + "type": "float | None", + "description": "Wholesale trade Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wholesale_trade_hours_worked", + "type": "float | None", + "description": "Wholesale trade Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wholesale_trade_labor_productivity_output_per_hour", + "type": "float | None", + "description": "Wholesale trade Labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade Labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade_output", + "type": "float | None", + "description": "Retail trade Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade_hours_worked", + "type": "float | None", + "description": "Retail trade Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade_labor_productivity_output_per_hour", + "type": "float | None", + "description": "Retail trade Labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade Labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWrIndexesBySector", + "openapi_extra": { + "model": "BlsWrIndexesBySector" + } + }, + "/bls/productivity/wr_lp_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Labor Productivity Indexes by Industry (1987=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_lp_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWrLpByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "wholesale_trade", + "type": "float | None", + "description": "Wholesale trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "motor_vehicles_and_parts", + "type": "float | None", + "description": "Motor vehicles and parts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Motor vehicles and parts", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_furnishings", + "type": "float | None", + "description": "Furniture and furnishings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and furnishings", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "lumber_and_construction_supplies", + "type": "float | None", + "description": "Lumber and construction supplies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lumber and construction supplies", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "commercial_equipment", + "type": "float | None", + "description": "Commercial equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commercial equipment", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metals_and_minerals", + "type": "float | None", + "description": "Metals and minerals.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metals and minerals", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "appliances_and_electric_goods", + "type": "float | None", + "description": "Appliances and electric goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Appliances and electric goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "hardware_and_plumbing", + "type": "float | None", + "description": "Hardware and plumbing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hardware and plumbing", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_and_supplies", + "type": "float | None", + "description": "Machinery and supplies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery and supplies", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_durable_goods", + "type": "float | None", + "description": "Miscellaneous durable goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous durable goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_and_paper_products", + "type": "float | None", + "description": "Paper and paper products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper and paper products", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "druggists_goods", + "type": "float | None", + "description": "Druggists' goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Druggists' goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_and_piece_goods", + "type": "float | None", + "description": "Apparel and piece goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel and piece goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "grocery_and_related_products", + "type": "float | None", + "description": "Grocery and related products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grocery and related products", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "farm_product_raw_materials", + "type": "float | None", + "description": "Farm product raw materials.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farm product raw materials", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals", + "type": "float | None", + "description": "Chemicals.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum", + "type": "float | None", + "description": "Petroleum.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "alcoholic_beverages", + "type": "float | None", + "description": "Alcoholic beverages.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Alcoholic beverages", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_nondurable_goods", + "type": "float | None", + "description": "Miscellaneous nondurable goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous nondurable goods", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electronic_markets_and_agents_and_brokers", + "type": "float | None", + "description": "Electronic markets and agents and brokers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electronic markets and agents and brokers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade", + "type": "float | None", + "description": "Retail trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "automobile_dealers", + "type": "float | None", + "description": "Automobile dealers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Automobile dealers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "other_motor_vehicle_dealers", + "type": "float | None", + "description": "Other motor vehicle dealers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other motor vehicle dealers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "auto_parts_accessories_and_tire_stores", + "type": "float | None", + "description": "Auto parts, accessories, and tire stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Auto parts, accessories, and tire stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_stores", + "type": "float | None", + "description": "Furniture stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "home_furnishings_stores", + "type": "float | None", + "description": "Home furnishings stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Home furnishings stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electronics_and_appliance_stores", + "type": "float | None", + "description": "Electronics and appliance stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electronics and appliance stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "building_material_and_supplies_dealers", + "type": "float | None", + "description": "Building material and supplies dealers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Building material and supplies dealers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "lawn_and_garden_equipment_and_supplies_stores", + "type": "float | None", + "description": "Lawn and garden equipment and supplies stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lawn and garden equipment and supplies stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "grocery_stores", + "type": "float | None", + "description": "Grocery stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grocery stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "specialty_food_stores", + "type": "float | None", + "description": "Specialty food stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Specialty food stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beer_wine_and_liquor_stores", + "type": "float | None", + "description": "Beer, wine and liquor stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beer, wine and liquor stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "health_and_personal_care_stores", + "type": "float | None", + "description": "Health and personal care stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Health and personal care stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "gasoline_stations", + "type": "float | None", + "description": "Gasoline stations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gasoline stations", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "clothing_stores", + "type": "float | None", + "description": "Clothing stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Clothing stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "shoe_stores", + "type": "float | None", + "description": "Shoe stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Shoe stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "jewelry_luggage_and_leather_goods_stores", + "type": "float | None", + "description": "Jewelry, luggage, and leather goods stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jewelry, luggage, and leather goods stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "sporting_goods_and_musical_instrument_stores", + "type": "float | None", + "description": "Sporting goods and musical instrument stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sporting goods and musical instrument stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "book_stores_and_news_dealers", + "type": "float | None", + "description": "Book stores and news dealers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Book stores and news dealers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "department_stores", + "type": "float | None", + "description": "Department stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Department stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "other_general_merchandise_stores", + "type": "float | None", + "description": "Other general merchandise stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other general merchandise stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "florists", + "type": "float | None", + "description": "Florists.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Florists", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "office_supplies_stationery_and_gift_stores", + "type": "float | None", + "description": "Office supplies, stationery and gift stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Office supplies, stationery and gift stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "used_merchandise_stores", + "type": "float | None", + "description": "Used merchandise stores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Used merchandise stores", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "other_miscellaneous_store_retailers", + "type": "float | None", + "description": "Other miscellaneous store retailers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other miscellaneous store retailers", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electronic_shopping_and_mail_order_houses", + "type": "float | None", + "description": "Electronic shopping and mail-order houses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electronic shopping and mail-order houses", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "vending_machine_operators", + "type": "float | None", + "description": "Vending machine operators.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vending machine operators", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "direct_selling_establishments", + "type": "float | None", + "description": "Direct selling establishments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Direct selling establishments", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWrLpByIndustry", + "openapi_extra": { + "model": "BlsWrLpByIndustry" + } + }, + "/bls/productivity/wr_1yr_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 1-Year % Change in Hours and Output, and Employment Level.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_1yr_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWr1yrChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "hours", + "type": "float | None", + "description": "Hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "employment_level", + "type": "float | None", + "description": "Employment level.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment level", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWr1yrChange", + "openapi_extra": { + "model": "BlsWr1yrChange" + } + }, + "/bls/productivity/wr_longterm_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Long-Term % Change in Hours and Output, and Employment Level.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_longterm_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWrLongtermChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "hours", + "type": "float | None", + "description": "Hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "employment_level", + "type": "float | None", + "description": "Employment level.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment level", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWrLongtermChange", + "openapi_extra": { + "model": "BlsWrLongtermChange" + } + }, + "/bls/productivity/wr_labor_cost_by_sector": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Labor Productivity, Unit Labor Costs, and Hourly Compensation Indexes by Sector (1987=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.wr_labor_cost_by_sector(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsWrLaborCostBySector", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "wholesale_trade_labor_productivity_output_per_hour", + "type": "float | None", + "description": "Wholesale trade labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wholesale_trade_unit_labor_costs", + "type": "float | None", + "description": "Wholesale trade unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wholesale_trade_hourly_compensation", + "type": "float | None", + "description": "Wholesale trade hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wholesale trade hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade_labor_productivity_output_per_hour", + "type": "float | None", + "description": "Retail trade labor productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade labor productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade_unit_labor_costs", + "type": "float | None", + "description": "Retail trade unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "retail_trade_hourly_compensation", + "type": "float | None", + "description": "Retail trade hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail trade hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsWrLaborCostBySector", + "openapi_extra": { + "model": "BlsWrLaborCostBySector" + } + }, + "/bls/productivity/mm_productivity_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Percent Change in Productivity by Industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.mm_productivity_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsMmProductivityChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "productivity_1_year_percent_change_2024", + "type": "float | None", + "description": "Productivity 1-year percent change, 2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Productivity 1-year percent change, 2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "productivity_annual_percent_change_1987_2024", + "type": "float | None", + "description": "Productivity annual percent change, 1987-2024.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Productivity annual percent change, 1987-2024", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsMmProductivityChange", + "openapi_extra": { + "model": "BlsMmProductivityChange" + } + }, + "/bls/productivity/mm_productivity_by_period": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Percent Change in Productivity by Select Periods.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.mm_productivity_by_period(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsMmProductivityByPeriod", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "mining", + "type": "float | None", + "description": "Mining.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "oil_and_gas_extraction", + "type": "float | None", + "description": "Oil and gas extraction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "mining_except_oil_and_gas", + "type": "float | None", + "description": "Mining, except oil and gas.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "coal_mining", + "type": "float | None", + "description": "Coal mining.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "metal_ore_mining", + "type": "float | None", + "description": "Metal ore mining.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "support_activities_for_mining", + "type": "float | None", + "description": "Support activities for mining.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "food", + "type": "float | None", + "description": "Food.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "beverages_and_tobacco_products", + "type": "float | None", + "description": "Beverages and tobacco products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "textile_mills", + "type": "float | None", + "description": "Textile mills.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "textile_product_mills", + "type": "float | None", + "description": "Textile product mills.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "apparel", + "type": "float | None", + "description": "Apparel.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "leather_and_allied_products", + "type": "float | None", + "description": "Leather and allied products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "paper", + "type": "float | None", + "description": "Paper.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "printing_and_related_support_activities", + "type": "float | None", + "description": "Printing and related support activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "petroleum_and_coal_products", + "type": "float | None", + "description": "Petroleum and coal products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "chemicals", + "type": "float | None", + "description": "Chemicals.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "plastics_and_rubber_products", + "type": "float | None", + "description": "Plastics and rubber products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "wood_products", + "type": "float | None", + "description": "Wood products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "nonmetallic_mineral_products", + "type": "float | None", + "description": "Nonmetallic mineral products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "primary_metals", + "type": "float | None", + "description": "Primary metals.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "fabricated_metal_products", + "type": "float | None", + "description": "Fabricated metal products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "machinery", + "type": "float | None", + "description": "Machinery.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "computer_and_electronic_products", + "type": "float | None", + "description": "Computer and electronic products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "electrical_equipment_and_appliances", + "type": "float | None", + "description": "Electrical equipment and appliances.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "transportation_equipment", + "type": "float | None", + "description": "Transportation equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "furniture_and_related_products", + "type": "float | None", + "description": "Furniture and related products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "miscellaneous_manufacturing", + "type": "float | None", + "description": "Miscellaneous manufacturing.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "period", + "type": "str", + "description": "Period the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsMmProductivityByPeriod", + "openapi_extra": { + "model": "BlsMmProductivityByPeriod" + } + }, + "/bls/productivity/mm_indexes_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Output, Hours, and Productivity Indexes by Industry (1987=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.mm_indexes_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsMmIndexesByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "mining_productivity_output_per_hour", + "type": "float | None", + "description": "Mining Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_output", + "type": "float | None", + "description": "Mining Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_hours_worked", + "type": "float | None", + "description": "Mining Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oil_and_gas_extraction_productivity_output_per_hour", + "type": "float | None", + "description": "Oil and gas extraction Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oil_and_gas_extraction_output", + "type": "float | None", + "description": "Oil and gas extraction Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oil_and_gas_extraction_hours_worked", + "type": "float | None", + "description": "Oil and gas extraction Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_except_oil_and_gas_productivity_output_per_hour", + "type": "float | None", + "description": "Mining, except oil and gas Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_except_oil_and_gas_output", + "type": "float | None", + "description": "Mining, except oil and gas Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_except_oil_and_gas_hours_worked", + "type": "float | None", + "description": "Mining, except oil and gas Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "coal_mining_productivity_output_per_hour", + "type": "float | None", + "description": "Coal mining Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "coal_mining_output", + "type": "float | None", + "description": "Coal mining Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "coal_mining_hours_worked", + "type": "float | None", + "description": "Coal mining Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metal_ore_mining_productivity_output_per_hour", + "type": "float | None", + "description": "Metal ore mining Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metal_ore_mining_output", + "type": "float | None", + "description": "Metal ore mining Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metal_ore_mining_hours_worked", + "type": "float | None", + "description": "Metal ore mining Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying_productivity_output_per_hour", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying_output", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying_hours_worked", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "support_activities_for_mining_productivity_output_per_hour", + "type": "float | None", + "description": "Support activities for mining Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "support_activities_for_mining_output", + "type": "float | None", + "description": "Support activities for mining Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "support_activities_for_mining_hours_worked", + "type": "float | None", + "description": "Support activities for mining Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food_productivity_output_per_hour", + "type": "float | None", + "description": "Food Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food_output", + "type": "float | None", + "description": "Food Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food_hours_worked", + "type": "float | None", + "description": "Food Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beverages_and_tobacco_products_productivity_output_per_hour", + "type": "float | None", + "description": "Beverages and tobacco products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beverages_and_tobacco_products_output", + "type": "float | None", + "description": "Beverages and tobacco products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beverages_and_tobacco_products_hours_worked", + "type": "float | None", + "description": "Beverages and tobacco products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills_productivity_output_per_hour", + "type": "float | None", + "description": "Textile mills Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills_output", + "type": "float | None", + "description": "Textile mills Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills_hours_worked", + "type": "float | None", + "description": "Textile mills Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_product_mills_productivity_output_per_hour", + "type": "float | None", + "description": "Textile product mills Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_product_mills_output", + "type": "float | None", + "description": "Textile product mills Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_product_mills_hours_worked", + "type": "float | None", + "description": "Textile product mills Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_productivity_output_per_hour", + "type": "float | None", + "description": "Apparel Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_output", + "type": "float | None", + "description": "Apparel Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_hours_worked", + "type": "float | None", + "description": "Apparel Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leather_and_allied_products_productivity_output_per_hour", + "type": "float | None", + "description": "Leather and allied products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leather_and_allied_products_output", + "type": "float | None", + "description": "Leather and allied products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leather_and_allied_products_hours_worked", + "type": "float | None", + "description": "Leather and allied products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_productivity_output_per_hour", + "type": "float | None", + "description": "Paper Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_output", + "type": "float | None", + "description": "Paper Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_hours_worked", + "type": "float | None", + "description": "Paper Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing_and_related_support_activities_productivity_output_per_hour", + "type": "float | None", + "description": "Printing and related support activities Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing_and_related_support_activities_output", + "type": "float | None", + "description": "Printing and related support activities Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing_and_related_support_activities_hours_worked", + "type": "float | None", + "description": "Printing and related support activities Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum_and_coal_products_productivity_output_per_hour", + "type": "float | None", + "description": "Petroleum and coal products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum_and_coal_products_output", + "type": "float | None", + "description": "Petroleum and coal products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum_and_coal_products_hours_worked", + "type": "float | None", + "description": "Petroleum and coal products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals_productivity_output_per_hour", + "type": "float | None", + "description": "Chemicals Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals_output", + "type": "float | None", + "description": "Chemicals Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals_hours_worked", + "type": "float | None", + "description": "Chemicals Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber_products_productivity_output_per_hour", + "type": "float | None", + "description": "Plastics and rubber products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber_products_output", + "type": "float | None", + "description": "Plastics and rubber products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber_products_hours_worked", + "type": "float | None", + "description": "Plastics and rubber products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_products_productivity_output_per_hour", + "type": "float | None", + "description": "Wood products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_products_output", + "type": "float | None", + "description": "Wood products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_products_hours_worked", + "type": "float | None", + "description": "Wood products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_products_productivity_output_per_hour", + "type": "float | None", + "description": "Nonmetallic mineral products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_products_output", + "type": "float | None", + "description": "Nonmetallic mineral products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_products_hours_worked", + "type": "float | None", + "description": "Nonmetallic mineral products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metals_productivity_output_per_hour", + "type": "float | None", + "description": "Primary metals Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metals_output", + "type": "float | None", + "description": "Primary metals Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metals_hours_worked", + "type": "float | None", + "description": "Primary metals Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal_products_productivity_output_per_hour", + "type": "float | None", + "description": "Fabricated metal products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal_products_output", + "type": "float | None", + "description": "Fabricated metal products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal_products_hours_worked", + "type": "float | None", + "description": "Fabricated metal products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_productivity_output_per_hour", + "type": "float | None", + "description": "Machinery Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_output", + "type": "float | None", + "description": "Machinery Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_hours_worked", + "type": "float | None", + "description": "Machinery Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_productivity_output_per_hour", + "type": "float | None", + "description": "Computer and electronic products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_output", + "type": "float | None", + "description": "Computer and electronic products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_hours_worked", + "type": "float | None", + "description": "Computer and electronic products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment_and_appliances_productivity_output_per_hour", + "type": "float | None", + "description": "Electrical equipment and appliances Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment_and_appliances_output", + "type": "float | None", + "description": "Electrical equipment and appliances Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment_and_appliances_hours_worked", + "type": "float | None", + "description": "Electrical equipment and appliances Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment_productivity_output_per_hour", + "type": "float | None", + "description": "Transportation equipment Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment_output", + "type": "float | None", + "description": "Transportation equipment Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment_hours_worked", + "type": "float | None", + "description": "Transportation equipment Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_related_products_productivity_output_per_hour", + "type": "float | None", + "description": "Furniture and related products Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_related_products_output", + "type": "float | None", + "description": "Furniture and related products Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_related_products_hours_worked", + "type": "float | None", + "description": "Furniture and related products Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_manufacturing_productivity_output_per_hour", + "type": "float | None", + "description": "Miscellaneous manufacturing Productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing Productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_manufacturing_output", + "type": "float | None", + "description": "Miscellaneous manufacturing Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing Output", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_manufacturing_hours_worked", + "type": "float | None", + "description": "Miscellaneous manufacturing Hours worked.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing Hours worked", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsMmIndexesByIndustry", + "openapi_extra": { + "model": "BlsMmIndexesByIndustry" + } + }, + "/bls/productivity/mm_1yr_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 1-Year % Change in Hours and Output, and Employment Level.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.mm_1yr_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsMm1yrChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "hours", + "type": "float | None", + "description": "Hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "employment_level", + "type": "float | None", + "description": "Employment level.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment level", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsMm1yrChange", + "openapi_extra": { + "model": "BlsMm1yrChange" + } + }, + "/bls/productivity/mm_longterm_change": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Long-Term % Change in Hours and Output, and Employment Level.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.mm_longterm_change(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsMmLongtermChange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "hours", + "type": "float | None", + "description": "Hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hours", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "output", + "type": "float | None", + "description": "Output.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Output", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "greenRed" + } + } + }, + { + "name": "employment_level", + "type": "float | None", + "description": "Employment level.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment level", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "industry", + "type": "str", + "description": "Industry the row applies to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry", + "chartDataType": "category" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsMmLongtermChange", + "openapi_extra": { + "model": "BlsMmLongtermChange" + } + }, + "/bls/productivity/mm_labor_cost_by_industry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Productivity and Costs chart \u2014 Labor Productivity, Unit Labor Costs, and Hourly Compensation Indexes by Industry (1987=100).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.productivity.mm_labor_cost_by_industry(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsMmLaborCostByIndustry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "mining_productivity_output_per_hour", + "type": "float | None", + "description": "Mining productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_unit_labor_costs", + "type": "float | None", + "description": "Mining unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_hourly_compensation", + "type": "float | None", + "description": "Mining hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oil_and_gas_extraction_productivity_output_per_hour", + "type": "float | None", + "description": "Oil and gas extraction productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oil_and_gas_extraction_unit_labor_costs", + "type": "float | None", + "description": "Oil and gas extraction unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "oil_and_gas_extraction_hourly_compensation", + "type": "float | None", + "description": "Oil and gas extraction hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oil and gas extraction hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_except_oil_and_gas_productivity_output_per_hour", + "type": "float | None", + "description": "Mining, except oil and gas productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_except_oil_and_gas_unit_labor_costs", + "type": "float | None", + "description": "Mining, except oil and gas unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "mining_except_oil_and_gas_hourly_compensation", + "type": "float | None", + "description": "Mining, except oil and gas hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining, except oil and gas hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "coal_mining_productivity_output_per_hour", + "type": "float | None", + "description": "Coal mining productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "coal_mining_unit_labor_costs", + "type": "float | None", + "description": "Coal mining unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "coal_mining_hourly_compensation", + "type": "float | None", + "description": "Coal mining hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coal mining hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metal_ore_mining_productivity_output_per_hour", + "type": "float | None", + "description": "Metal ore mining productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metal_ore_mining_unit_labor_costs", + "type": "float | None", + "description": "Metal ore mining unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "metal_ore_mining_hourly_compensation", + "type": "float | None", + "description": "Metal ore mining hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metal ore mining hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying_productivity_output_per_hour", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying_unit_labor_costs", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_mining_and_quarrying_hourly_compensation", + "type": "float | None", + "description": "Nonmetallic mineral mining and quarrying hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral mining and quarrying hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "support_activities_for_mining_productivity_output_per_hour", + "type": "float | None", + "description": "Support activities for mining productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "support_activities_for_mining_unit_labor_costs", + "type": "float | None", + "description": "Support activities for mining unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "support_activities_for_mining_hourly_compensation", + "type": "float | None", + "description": "Support activities for mining hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Support activities for mining hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food_productivity_output_per_hour", + "type": "float | None", + "description": "Food productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food_unit_labor_costs", + "type": "float | None", + "description": "Food unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "food_hourly_compensation", + "type": "float | None", + "description": "Food hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beverages_and_tobacco_products_productivity_output_per_hour", + "type": "float | None", + "description": "Beverages and tobacco products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beverages_and_tobacco_products_unit_labor_costs", + "type": "float | None", + "description": "Beverages and tobacco products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "beverages_and_tobacco_products_hourly_compensation", + "type": "float | None", + "description": "Beverages and tobacco products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beverages and tobacco products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills_productivity_output_per_hour", + "type": "float | None", + "description": "Textile mills productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills_unit_labor_costs", + "type": "float | None", + "description": "Textile mills unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_mills_hourly_compensation", + "type": "float | None", + "description": "Textile mills hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile mills hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_product_mills_productivity_output_per_hour", + "type": "float | None", + "description": "Textile product mills productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_product_mills_unit_labor_costs", + "type": "float | None", + "description": "Textile product mills unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "textile_product_mills_hourly_compensation", + "type": "float | None", + "description": "Textile product mills hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Textile product mills hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_productivity_output_per_hour", + "type": "float | None", + "description": "Apparel productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_unit_labor_costs", + "type": "float | None", + "description": "Apparel unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "apparel_hourly_compensation", + "type": "float | None", + "description": "Apparel hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Apparel hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leather_and_allied_products_productivity_output_per_hour", + "type": "float | None", + "description": "Leather and allied products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leather_and_allied_products_unit_labor_costs", + "type": "float | None", + "description": "Leather and allied products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "leather_and_allied_products_hourly_compensation", + "type": "float | None", + "description": "Leather and allied products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Leather and allied products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_productivity_output_per_hour", + "type": "float | None", + "description": "Paper productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_unit_labor_costs", + "type": "float | None", + "description": "Paper unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "paper_hourly_compensation", + "type": "float | None", + "description": "Paper hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paper hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing_and_related_support_activities_productivity_output_per_hour", + "type": "float | None", + "description": "Printing and related support activities productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing_and_related_support_activities_unit_labor_costs", + "type": "float | None", + "description": "Printing and related support activities unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "printing_and_related_support_activities_hourly_compensation", + "type": "float | None", + "description": "Printing and related support activities hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Printing and related support activities hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum_and_coal_products_productivity_output_per_hour", + "type": "float | None", + "description": "Petroleum and coal products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum_and_coal_products_unit_labor_costs", + "type": "float | None", + "description": "Petroleum and coal products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "petroleum_and_coal_products_hourly_compensation", + "type": "float | None", + "description": "Petroleum and coal products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Petroleum and coal products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals_productivity_output_per_hour", + "type": "float | None", + "description": "Chemicals productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals_unit_labor_costs", + "type": "float | None", + "description": "Chemicals unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "chemicals_hourly_compensation", + "type": "float | None", + "description": "Chemicals hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chemicals hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber_products_productivity_output_per_hour", + "type": "float | None", + "description": "Plastics and rubber products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber_products_unit_labor_costs", + "type": "float | None", + "description": "Plastics and rubber products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "plastics_and_rubber_products_hourly_compensation", + "type": "float | None", + "description": "Plastics and rubber products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Plastics and rubber products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_products_productivity_output_per_hour", + "type": "float | None", + "description": "Wood products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_products_unit_labor_costs", + "type": "float | None", + "description": "Wood products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "wood_products_hourly_compensation", + "type": "float | None", + "description": "Wood products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wood products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_products_productivity_output_per_hour", + "type": "float | None", + "description": "Nonmetallic mineral products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_products_unit_labor_costs", + "type": "float | None", + "description": "Nonmetallic mineral products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "nonmetallic_mineral_products_hourly_compensation", + "type": "float | None", + "description": "Nonmetallic mineral products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonmetallic mineral products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metals_productivity_output_per_hour", + "type": "float | None", + "description": "Primary metals productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metals_unit_labor_costs", + "type": "float | None", + "description": "Primary metals unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "primary_metals_hourly_compensation", + "type": "float | None", + "description": "Primary metals hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary metals hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal_products_productivity_output_per_hour", + "type": "float | None", + "description": "Fabricated metal products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal_products_unit_labor_costs", + "type": "float | None", + "description": "Fabricated metal products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "fabricated_metal_products_hourly_compensation", + "type": "float | None", + "description": "Fabricated metal products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fabricated metal products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_productivity_output_per_hour", + "type": "float | None", + "description": "Machinery productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_unit_labor_costs", + "type": "float | None", + "description": "Machinery unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "machinery_hourly_compensation", + "type": "float | None", + "description": "Machinery hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Machinery hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_productivity_output_per_hour", + "type": "float | None", + "description": "Computer and electronic products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_unit_labor_costs", + "type": "float | None", + "description": "Computer and electronic products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "computer_and_electronic_products_hourly_compensation", + "type": "float | None", + "description": "Computer and electronic products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Computer and electronic products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment_and_appliances_productivity_output_per_hour", + "type": "float | None", + "description": "Electrical equipment and appliances productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment_and_appliances_unit_labor_costs", + "type": "float | None", + "description": "Electrical equipment and appliances unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "electrical_equipment_and_appliances_hourly_compensation", + "type": "float | None", + "description": "Electrical equipment and appliances hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Electrical equipment and appliances hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment_productivity_output_per_hour", + "type": "float | None", + "description": "Transportation equipment productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment_unit_labor_costs", + "type": "float | None", + "description": "Transportation equipment unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "transportation_equipment_hourly_compensation", + "type": "float | None", + "description": "Transportation equipment hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transportation equipment hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_related_products_productivity_output_per_hour", + "type": "float | None", + "description": "Furniture and related products productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_related_products_unit_labor_costs", + "type": "float | None", + "description": "Furniture and related products unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "furniture_and_related_products_hourly_compensation", + "type": "float | None", + "description": "Furniture and related products hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Furniture and related products hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_manufacturing_productivity_output_per_hour", + "type": "float | None", + "description": "Miscellaneous manufacturing productivity (output per hour).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing productivity (output per hour)", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_manufacturing_unit_labor_costs", + "type": "float | None", + "description": "Miscellaneous manufacturing unit labor costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing unit labor costs", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "miscellaneous_manufacturing_hourly_compensation", + "type": "float | None", + "description": "Miscellaneous manufacturing hourly compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miscellaneous manufacturing hourly compensation", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation period (year).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source table id.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsMmLaborCostByIndustry", + "openapi_extra": { + "model": "BlsMmLaborCostByIndustry" + } + }, + "/bls/real_earnings/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List BLS Real Earnings release PDFs for the file viewer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All Real Earnings release PDFs (current + archive).\nobb.bls.real_earnings.documents(provider='bls')\n# Only 2024 archived releases.\nobb.bls.real_earnings.documents(provider='bls', category='archived', start_date='2024-01-01', end_date='2024-12-31')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Which family of BLS Real Earnings release PDFs to enumerate.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All documents", + "value": "all" + }, + { + "label": "Current release PDF only", + "value": "current" + }, + { + "label": "Archived releases", + "value": "archived" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsRealerDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "Human-readable document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the PDF on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family (current or archived).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Release publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format of the document.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsRealerDocuments", + "openapi_extra": { + "model": "BlsRealerDocuments" + } + }, + "/bls/import_export/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List BLS U.S. Import and Export Price Index release PDFs for the file viewer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All XIMPIM release PDFs (current + archive).\nobb.bls.import_export.documents(provider='bls')\n# Only 2024 archived releases.\nobb.bls.import_export.documents(provider='bls', category='archived', start_date='2024-01-01', end_date='2024-12-31')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Which family of BLS XIMPIM release PDFs to enumerate.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All documents", + "value": "all" + }, + { + "label": "Current release PDF only", + "value": "current" + }, + { + "label": "Archived releases", + "value": "archived" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest publication date to include (inclusive). Applies to archived releases only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "name", + "type": "str", + "description": "Human-readable document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Absolute HTTPS URL to the PDF on bls.gov.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "Document family (current or archived).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "Release publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "format", + "type": "str | None", + "description": "File format of the document.", + "default": "pdf", + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsXimpimDocuments", + "openapi_extra": { + "model": "BlsXimpimDocuments" + } + }, + "/bls/import_export/price_indexes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS import/export price indexes, 12-month percent change (headline series).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.import_export.price_indexes(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimImportExport", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "all_imports", + "type": "float | None", + "description": "12-month percent change \u2014 All imports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "All imports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "fuel_imports", + "type": "float | None", + "description": "12-month percent change \u2014 Fuel imports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fuel imports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "nonfuel_imports", + "type": "float | None", + "description": "12-month percent change \u2014 Nonfuel imports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonfuel imports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "all_exports", + "type": "float | None", + "description": "12-month percent change \u2014 All exports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "All exports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "agricultural_exports", + "type": "float | None", + "description": "12-month percent change \u2014 Agricultural exports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Agricultural exports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "nonagricultural_exports", + "type": "float | None", + "description": "12-month percent change \u2014 Nonagricultural exports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonagricultural exports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source data-table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsXimpimImportExport", + "openapi_extra": { + "model": "BlsXimpimImportExport" + } + }, + "/bls/import_export/imports_by_category": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS U.S. import price indexes by end-use category, 12-month percent change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.import_export.imports_by_category(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimImportsByCategory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "all_imports", + "type": "float | None", + "description": "12-month percent change \u2014 All imports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "All imports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "foods_feeds_beverages", + "type": "float | None", + "description": "12-month percent change \u2014 Foods, feeds, and beverages.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Foods, feeds, and beverages", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "industrial_supplies", + "type": "float | None", + "description": "12-month percent change \u2014 Industrial supplies and materials.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industrial supplies and materials", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "capital_goods", + "type": "float | None", + "description": "12-month percent change \u2014 Capital goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Capital goods", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "automotive", + "type": "float | None", + "description": "12-month percent change \u2014 Automotive vehicles, parts and engines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Automotive vehicles, parts and engines", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "consumer_goods", + "type": "float | None", + "description": "12-month percent change \u2014 Consumer goods, excluding automotives.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Consumer goods, excluding automotives", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source data-table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsXimpimImportsByCategory", + "openapi_extra": { + "model": "BlsXimpimImportsByCategory" + } + }, + "/bls/import_export/exports_by_category": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS U.S. export price indexes by end-use category, 12-month percent change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.import_export.exports_by_category(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimExportsByCategory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "all_exports", + "type": "float | None", + "description": "12-month percent change \u2014 All exports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "All exports", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "foods_feeds_beverages", + "type": "float | None", + "description": "12-month percent change \u2014 Foods, feeds, and beverages.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Foods, feeds, and beverages", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "industrial_supplies", + "type": "float | None", + "description": "12-month percent change \u2014 Industrial supplies and materials.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industrial supplies and materials", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "capital_goods", + "type": "float | None", + "description": "12-month percent change \u2014 Capital goods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Capital goods", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "automotive", + "type": "float | None", + "description": "12-month percent change \u2014 Automotive vehicles, parts and engines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Automotive vehicles, parts and engines", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "consumer_goods", + "type": "float | None", + "description": "12-month percent change \u2014 Consumer goods, excluding automotives.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Consumer goods, excluding automotives", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source data-table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsXimpimExportsByCategory", + "openapi_extra": { + "model": "BlsXimpimExportsByCategory" + } + }, + "/bls/import_export/imports_by_origin": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS U.S. import price indexes by locality of origin, 12-month percent change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.import_export.imports_by_origin(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimImportsByOrigin", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "canada", + "type": "float | None", + "description": "12-month percent change \u2014 Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "european_union", + "type": "float | None", + "description": "12-month percent change \u2014 European Union.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "European Union", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "12-month percent change \u2014 France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "12-month percent change \u2014 Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "12-month percent change \u2014 United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "latin_america", + "type": "float | None", + "description": "12-month percent change \u2014 Latin America.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latin America", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "12-month percent change \u2014 Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "pacific_rim", + "type": "float | None", + "description": "12-month percent change \u2014 Pacific Rim.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pacific Rim", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "12-month percent change \u2014 China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "12-month percent change \u2014 Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source data-table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsXimpimImportsByOrigin", + "openapi_extra": { + "model": "BlsXimpimImportsByOrigin" + } + }, + "/bls/import_export/exports_by_grains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS U.S. export price indexes by selected grains, 12-month percent change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.import_export.exports_by_grains(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimExportsByGrains", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "wheat", + "type": "float | None", + "description": "12-month percent change \u2014 Wheat.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Wheat", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "soybeans", + "type": "float | None", + "description": "12-month percent change \u2014 Soybeans.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Soybeans", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "corn", + "type": "float | None", + "description": "12-month percent change \u2014 Corn.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Corn", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source data-table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsXimpimExportsByGrains", + "openapi_extra": { + "model": "BlsXimpimExportsByGrains" + } + }, + "/bls/import_export/air_passenger_fares": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS air passenger fares (import and export), 12-month percent change.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.bls.import_export.air_passenger_fares(provider='bls')\n```\n\n", + "parameters": { + "standard": [], + "bls": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsXimpimAirFares", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "bls": [ + { + "name": "import_fares", + "type": "float | None", + "description": "12-month percent change \u2014 Import air passenger fares.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Import air passenger fares", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "import_europe", + "type": "float | None", + "description": "12-month percent change \u2014 Import Europe.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Import Europe", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "import_asia", + "type": "float | None", + "description": "12-month percent change \u2014 Import Asia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Import Asia", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "import_latam", + "type": "float | None", + "description": "12-month percent change \u2014 Import Latin America/Caribbean.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Import Latin America/Caribbean", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "export_fares", + "type": "float | None", + "description": "12-month percent change \u2014 Export air passenger fares.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Export air passenger fares", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "export_europe", + "type": "float | None", + "description": "12-month percent change \u2014 Export Europe.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Export Europe", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "export_asia", + "type": "float | None", + "description": "12-month percent change \u2014 Export Asia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Export Asia", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "export_latam", + "type": "float | None", + "description": "12-month percent change \u2014 Export Latin America/Caribbean.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Export Latin America/Caribbean", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed", + "chartDataType": "series" + } + } + }, + { + "name": "date", + "type": "date | str", + "description": "Observation month (first of month).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "chartDataType": "time" + } + } + }, + { + "name": "chart", + "type": "str", + "description": "Chart key the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "chart_title", + "type": "str", + "description": "Full BLS chart title.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "table_id", + "type": "str", + "description": "Source data-table identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "BlsXimpimAirFares", + "openapi_extra": { + "model": "BlsXimpimAirFares" + } + }, + "/bls/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the BLS series catalog by category, keyword, or code.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the CPI category for series matching a query.\nobb.bls.search(provider='bls', category='cpi', query='urban')\n# List every series in the JOLTS category.\nobb.bls.search(provider='bls', category='jolts')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "The search word(s). Use semi-colon to separate multiple queries as an & operator.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "bls": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Bound to the Series widget via cell-click grouping; clicking a row's symbol loads it there. Does not filter the search results. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/bls/series/symbol_choices", + "optionsParams": { + "category": "$category" + }, + "show": false + } + } + }, + { + "name": "category", + "type": "str", + "description": "The category of BLS survey to search within. An empty search query returns every series within the category. Options are:\n\n cpi - Consumer Price Index\n ixp - Import/Export Price Indexes\n pce - Consumer Expenditure Survey\n ppi - Producer Price Index\n ip - Productivity (Industry, Major Sector & Total Factor)\n jolts - Job Openings and Labor Turnover Survey\n nfp - Nonfarm Payrolls (Current Employment Statistics)\n cps - Current Population Survey\n lfs - Labor Force Statistics & International Comparisons\n wages - Employment Cost Index & Wage Estimates\n ec - Employer Costs for Employee Compensation\n sla - State & Local Area Employment & Unemployment\n bed - Business Employment Dynamics\n tu - American Time Use Survey", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Consumer Price Index", + "value": "cpi" + }, + { + "label": "Import/Export Price Indexes", + "value": "ixp" + }, + { + "label": "Consumer Expenditure Survey", + "value": "pce" + }, + { + "label": "Producer Price Index", + "value": "ppi" + }, + { + "label": "Productivity (Industry, Major Sector & Total Factor)", + "value": "ip" + }, + { + "label": "Job Openings and Labor Turnover Survey", + "value": "jolts" + }, + { + "label": "Nonfarm Payrolls (Current Employment Statistics)", + "value": "nfp" + }, + { + "label": "Current Population Survey", + "value": "cps" + }, + { + "label": "Labor Force Statistics & International Comparisons", + "value": "lfs" + }, + { + "label": "Employment Cost Index & Wage Estimates", + "value": "wages" + }, + { + "label": "Employer Costs for Employee Compensation", + "value": "ec" + }, + { + "label": "State & Local Area Employment & Unemployment", + "value": "sla" + }, + { + "label": "Business Employment Dynamics", + "value": "bed" + }, + { + "label": "American Time Use Survey", + "value": "tu" + } + ] + } + } + }, + { + "name": "include_extras", + "type": "bool | None", + "description": "Include additional information in the search results. Extra fields returned are metadata and vary by survey. Fields are undefined strings that typically have names ending with '_code'.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_code_map", + "type": "bool | None", + "description": "When True, includes the complete code map for ea\u00e7h survey in the category, returned separately as a nested JSON to the `extras['results_metadata']` property of the response. Example content is the NAICS industry map for PPI surveys. Each code is a value within the 'symbol' of the time series.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "The title of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "survey_name", + "type": "str | None", + "description": "The name of the survey.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "bls": [ + { + "name": "symbol", + "type": "str", + "description": "BLS series identifier. Click a cell to load it into the linked BLS Series widget.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + } + } + ] + }, + "model": "BlsSearch", + "openapi_extra": { + "model": "BlsSearch" + } + }, + "/bls/series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch BLS time series data by series identifier.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fetch a single series by symbol from the BLS API.\nobb.bls.series(provider='bls', symbol='CUUR0000SA0')\n# Fetch multiple series with calculations enabled.\nobb.bls.series(provider='bls', symbol='CUUR0000SA0,WPUFD4', calculations=True)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): bls.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "bls": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/bls/series/symbol_choices", + "optionsParams": { + "category": "$category" + }, + "style": { + "popupWidth": 950 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "bls": [ + { + "name": "category", + "type": "str | None", + "description": "Survey category that scopes the symbol picker's choices. Does not filter the returned data (series are fetched by symbol); keep it in sync with the Search widget to drill down by clicking.", + "default": "cpi", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Consumer Price Index", + "value": "cpi" + }, + { + "label": "Import/Export Price Indexes", + "value": "ixp" + }, + { + "label": "Consumer Expenditure Survey", + "value": "pce" + }, + { + "label": "Producer Price Index", + "value": "ppi" + }, + { + "label": "Productivity (Industry, Major Sector & Total Factor)", + "value": "ip" + }, + { + "label": "Job Openings and Labor Turnover Survey", + "value": "jolts" + }, + { + "label": "Nonfarm Payrolls (Current Employment Statistics)", + "value": "nfp" + }, + { + "label": "Current Population Survey", + "value": "cps" + }, + { + "label": "Labor Force Statistics & International Comparisons", + "value": "lfs" + }, + { + "label": "Employment Cost Index & Wage Estimates", + "value": "wages" + }, + { + "label": "Employer Costs for Employee Compensation", + "value": "ec" + }, + { + "label": "State & Local Area Employment & Unemployment", + "value": "sla" + }, + { + "label": "Business Employment Dynamics", + "value": "bed" + }, + { + "label": "American Time Use Survey", + "value": "tu" + } + ] + } + } + }, + { + "name": "calculations", + "type": "bool | None", + "description": "Include calculations in the response, if available. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "annual_average", + "type": "bool | None", + "description": "Include annual averages in the response, if available. Default is False.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aspects", + "type": "bool | None", + "description": "Include all aspects associated with a data point for a given BLS series ID, if available. Returned with the series metadata, under `extras` of the response object. Default is False.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Title of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Observation value for the symbol and date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "bls": [ + { + "name": "date", + "type": "date | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Date", + "chartDataType": "time" + } + } + }, + { + "name": "symbol", + "type": "str", + "description": "BLS series identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Symbol", + "chartDataType": "category" + } + } + }, + { + "name": "value", + "type": "float | None", + "description": "Observation value for the symbol and date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Value", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "change_1M", + "type": "float | None", + "description": "One month change in value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "change_3M", + "type": "float | None", + "description": "Three month change in value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "change_6M", + "type": "float | None", + "description": "Six month change in value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "change_12M", + "type": "float | None", + "description": "One year change in value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "change_percent_1M", + "type": "float | None", + "description": "One month change in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100, + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "percent" + } + } + }, + { + "name": "change_percent_3M", + "type": "float | None", + "description": "Three month change in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100, + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "percent" + } + } + }, + { + "name": "change_percent_6M", + "type": "float | None", + "description": "Six month change in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100, + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "percent" + } + } + }, + { + "name": "change_percent_12M", + "type": "float | None", + "description": "One year change in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100, + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "percent" + } + } + }, + { + "name": "latest", + "type": "bool | None", + "description": "Latest value indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "footnotes", + "type": "str | None", + "description": "Footnotes accompanying the value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "BlsSeries", + "openapi_extra": { + "model": "BlsSeries" + } + }, + "/bls/calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "BLS Release Calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Current-month BLS release schedule.\nobb.bls.calendar(provider='bls')\n# Filter releases to a specific name across a window.\nobb.bls.calendar(provider='bls', start_date='2026-04-01', end_date='2026-06-30', release='Employment Situation')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "bls": [ + { + "name": "release", + "type": "str | None", + "description": "Case-insensitive substring filter on the BLS release name.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "BlsEconomicCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Category of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "event", + "type": "str | None", + "description": "Event name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "importance", + "type": "str | None", + "description": "The importance level for the event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Source of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus", + "type": "float | str | None", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous", + "type": "float | str | None", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revised", + "type": "float | str | None", + "description": "Revised previous value, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "actual", + "type": "float | str | None", + "description": "Latest released value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "bls": [ + { + "name": "country", + "type": "str | None", + "description": "Country code for the release.", + "default": "US", + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "category", + "type": "str | None", + "description": "Release category.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "importance", + "type": "str | None", + "description": "Importance rating of the release.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency associated with the release.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the release value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "consensus", + "type": "float | str | None", + "description": "Consensus forecast value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "previous", + "type": "float | str | None", + "description": "Prior-period value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "revised", + "type": "float | str | None", + "description": "Revised value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "actual", + "type": "float | str | None", + "description": "Realized release value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "period", + "type": "str | None", + "description": "Reporting period of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "time", + "type": "str | None", + "description": "Scheduled release time in Eastern Time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "news_release_url", + "type": "str | None", + "description": "Link to the release detail page.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "BlsEconomicCalendar", + "openapi_extra": { + "model": "BlsEconomicCalendar" + } + }, + "/cboe/equity/symbol_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every symbol in the Cboe company directory.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get symbol choices from the Cboe company directory.\nobb.cboe.equity.symbol_choices()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "use_cache", + "type": "bool", + "description": "When True, the company directory is cached for 24 hours.", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/cboe/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the Cboe US company directory for listed options symbols.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the Cboe company directory by company name.\nobb.cboe.equity.search(query='ETF', provider='cboe')\n# Search by ticker symbol instead of name.\nobb.cboe.equity.search(query='SPY', is_symbol=True, provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the company directory will be cached for 24 hours. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeEquitySearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "dpm_name", + "type": "str | None", + "description": "Name of the primary market maker.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "post_station", + "type": "str | None", + "description": "Post and station location on the Cboe trading floor.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeEquitySearch", + "openapi_extra": { + "model": "CboeEquitySearch" + } + }, + "/cboe/equity/quote": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Delayed Cboe quotes, with 30/60/90-day implied and realized volatility.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Delayed quote, with implied and realized volatility.\nobb.cboe.equity.quote(symbol='AAPL', provider='cboe')\n# Multiple symbols are comma-separated.\nobb.cboe.equity.quote(symbol='AAPL,MSFT', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/equity/symbol_choices", + "style": { + "popupWidth": 600 + } + } + } + } + } + ], + "cboe": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeEquityQuote", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company or asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "Price of the top bid order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "str | None", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "Price of the top ask order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "str | None", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_indicators", + "type": "int | list[int] | list[str] | str | None", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sequence_number", + "type": "int | None", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_center", + "type": "str | None", + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "participant_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trf_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sip_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "Price of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_tick", + "type": "str | None", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_size", + "type": "int | None", + "description": "Size of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_timestamp", + "type": "datetime | None", + "description": "Date and Time when the last price was recorded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_volume", + "type": "float | int | None", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price from previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "The one year high (52W High).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The one year low (52W Low).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "iv30", + "type": "float | None", + "description": "The 30-day implied volatility of the stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV30" + } + } + }, + { + "name": "iv30_change", + "type": "float | None", + "description": "Change in 30-day implied volatility of the stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV30 Change" + } + } + }, + { + "name": "iv30_change_percent", + "type": "float | None", + "description": "Change in 30-day implied volatility of the stock as a normalized percentage value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV30 Change %" + } + } + }, + { + "name": "iv30_annual_high", + "type": "float | None", + "description": "The 1-year high of 30-day implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV30 Annual High" + } + } + }, + { + "name": "hv30_annual_high", + "type": "float | None", + "description": "The 1-year high of 30-day realized volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "HV30 Annual High" + } + } + }, + { + "name": "iv30_annual_low", + "type": "float | None", + "description": "The 1-year low of 30-day implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV30 Annual Low" + } + } + }, + { + "name": "hv30_annual_low", + "type": "float | None", + "description": "The 1-year low of 30-day realized volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "HV30 Annual Low" + } + } + }, + { + "name": "iv60_annual_high", + "type": "float | None", + "description": "The 1-year high of 60-day implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV60 Annual High" + } + } + }, + { + "name": "hv60_annual_high", + "type": "float | None", + "description": "The 1-year high of 60-day realized volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "HV60 Annual High" + } + } + }, + { + "name": "iv60_annual_low", + "type": "float | None", + "description": "The 1-year low of 60-day implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV60 Annual Low" + } + } + }, + { + "name": "hv60_annual_low", + "type": "float | None", + "description": "The 1-year low of 60-day realized volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "HV60 Annual Low" + } + } + }, + { + "name": "iv90_annual_high", + "type": "float | None", + "description": "The 1-year high of 90-day implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV90 Annual High" + } + } + }, + { + "name": "hv90_annual_high", + "type": "float | None", + "description": "The 1-year high of 90-day realized volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "HV90 Annual High" + } + } + }, + { + "name": "iv90_annual_low", + "type": "float | None", + "description": "The 1-year low of 90-day implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "IV90 Annual Low" + } + } + }, + { + "name": "hv90_annual_low", + "type": "float | None", + "description": "The 1-year low of 90-day realized volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "HV90 Annual Low" + } + } + } + ] + }, + "model": "CboeEquityQuote", + "openapi_extra": { + "widget_config": { + "name": "Quote", + "description": "Delayed quote, with 30/60/90-day implied and realized volatility.", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 6 + }, + "params": [ + { + "paramName": "symbol", + "value": "SPY" + } + ] + }, + "model": "CboeEquityQuote" + } + }, + "/cboe/equity/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical equity and ETF prices from Cboe, daily or one-minute.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily historical prices. ETFs use this endpoint as well.\nobb.cboe.equity.historical(symbol='AAPL', provider='cboe')\n# One-minute bars for the most recent trading day.\nobb.cboe.equity.historical(symbol='AAPL', interval='1m', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/equity/symbol_choices", + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "1d" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeEquityHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "calls_volume", + "type": "int | None", + "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "puts_volume", + "type": "int | None", + "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_options_volume", + "type": "int | None", + "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeEquityHistorical", + "openapi_extra": { + "widget_config": { + "name": "Underlying Asset History", + "description": "Daily closing price of the underlying asset.", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "symbol", + "value": "SPY" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + }, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "pinned": "left", + "chartDataType": "category" + }, + { + "field": "close", + "headerName": "Close", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "open", + "headerName": "Open", + "cellDataType": "number", + "chartDataType": "excluded" + }, + { + "field": "high", + "headerName": "High", + "cellDataType": "number", + "chartDataType": "excluded" + }, + { + "field": "low", + "headerName": "Low", + "cellDataType": "number", + "chartDataType": "excluded" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number", + "chartDataType": "excluded" + } + ] + } + } + }, + "model": "CboeEquityHistorical" + } + }, + "/cboe/index/symbol_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every index in the Cboe index directory.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get symbol choices from the Cboe index directory.\nobb.cboe.index.symbol_choices()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "use_cache", + "type": "bool", + "description": "When True, the index directory is cached for 24 hours.", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/cboe/index/constituent_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of the Cboe European proprietary indices with constituents.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the Cboe European proprietary index choices.\nobb.cboe.index.constituent_choices()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "use_cache", + "type": "bool", + "description": "When True, the index directory is cached for 24 hours.", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/cboe/index/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the factsheets, methodologies, and governance documents Cboe publishes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The full Cboe index documents catalog.\nobb.cboe.index.documents(provider='cboe')\n# Documents that apply to a single index.\nobb.cboe.index.documents(symbol='X2C', provider='cboe')\n# Only the methodology documents.\nobb.cboe.index.documents(category='Methodology', provider='cboe')\n```\n\n", + "parameters": { + "standard": [], + "cboe": [ + { + "name": "symbol", + "type": "str | None", + "description": "Restrict the catalog to documents for this index symbol. Documents that apply to every index are always included, and the per-symbol factsheet when Cboe publishes one.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Restrict the catalog to one document category.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeIndexDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cboe": [ + { + "name": "category", + "type": "str", + "description": "The category of the document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The title of the document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The URL of the published PDF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbols", + "type": "list[str] | None", + "description": "Index symbols the document is specific to. Empty for documents that apply to every index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeIndexDocuments", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "CboeIndexDocuments" + } + }, + "/cboe/index/document_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of index documents, where the value is the PDF URL.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the documents available for an index.\nobb.cboe.index.document_choices(symbol='BXM')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Restrict the choices to one index symbol.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/cboe/index/documents_viewer": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open the selected Cboe index documents for the Workspace file viewer.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "params", + "type": "dict", + "description": "", + "default": null, + "optional": false + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "type": "multi_file_viewer", + "name": "Cboe Index Documents", + "description": "Factsheets, methodologies, and governance documents.", + "category": "Index", + "subCategory": "Reference", + "source": [ + "Cboe" + ], + "refetchInterval": false, + "gridData": { + "w": 40, + "h": 30 + }, + "params": [ + { + "paramName": "document_url", + "label": "Document", + "description": "Select the documents to open.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/index/document_choices", + "show": false, + "roles": [ + "fileSelector" + ], + "multiSelect": true, + "style": { + "popupWidth": 850 + } + } + ] + }, + "model": "" + } + }, + "/cboe/index/available": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "All indices available from Cboe, US and European.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All indices published by Cboe.\nobb.cboe.index.available(provider='cboe')\n```\n\n", + "parameters": { + "standard": [], + "cboe": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeAvailableIndices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Stock exchange where the index is listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the index is traded in.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol for the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_delay", + "type": "int | None", + "description": "Data delay for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_time", + "type": "time | None", + "description": "Opening time for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_time", + "type": "time | None", + "description": "Closing time for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "time_zone", + "type": "str | None", + "description": "Time zone for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick_days", + "type": "str | None", + "description": "The trading days for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick_frequency", + "type": "str | None", + "description": "The frequency of the index ticks. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick_period", + "type": "str | None", + "description": "The period of the index ticks. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeAvailableIndices", + "openapi_extra": { + "model": "CboeAvailableIndices" + } + }, + "/cboe/index/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Filter the Cboe index directory for rows containing the query.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the Cboe index directory.\nobb.cboe.index.search(query='uk', provider='cboe')\n# Restrict the search to ticker symbols.\nobb.cboe.index.search(query='BUK', is_symbol=True, provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeIndexSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "description", + "type": "str | None", + "description": "Description for the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_delay", + "type": "int | None", + "description": "Data delay for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency for the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "time_zone", + "type": "str | None", + "description": "Time zone for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_time", + "type": "time | None", + "description": "Opening time for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_time", + "type": "time | None", + "description": "Closing time for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick_days", + "type": "str | None", + "description": "The trading days for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick_frequency", + "type": "str | None", + "description": "Tick frequency for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick_period", + "type": "str | None", + "description": "Tick period for the index. Valid only for US indices.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeIndexSearch", + "openapi_extra": { + "widget_config": { + "name": "Index Search", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/index/symbol_choices", + "value": "VIX", + "multiSelect": false, + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "headerName": "Symbol", + "cellDataType": "text", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "CboeIndexSearch" + } + }, + "/cboe/index/snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get current levels for all Cboe indices, grouped by region.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Current levels for all US indices.\nobb.cboe.index.snapshots(region='us', provider='cboe')\n# Current levels for all European indices.\nobb.cboe.index.snapshots(region='eu', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "region", + "type": "str | None", + "description": "The region of focus for the data - i.e., us, eu.", + "default": "us", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "choices": [ + "us", + "eu", + "au" + ] + } + } + } + ], + "cboe": [ + { + "name": "region", + "type": "str | None", + "description": "The region of focus for the data - i.e., us, eu, au. 'au' covers the Cboe Australia (CXA) indices.", + "default": "us", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeIndexSnapshots", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Current price of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in value of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change, in normalized percentage points, of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "Current bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "Current ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "datetime | None", + "description": "Last trade timestamp for the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "Status of the market, open or closed.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeIndexSnapshots", + "openapi_extra": { + "widget_config": { + "name": "Index Snapshots", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/index/symbol_choices", + "value": "VIX", + "multiSelect": false, + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "headerName": "Symbol", + "cellDataType": "text", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "CboeIndexSnapshots" + } + }, + "/cboe/index/constituents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get current trading day prices for the constituents of a Cboe European index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Current constituents of a Cboe European index.\nobb.cboe.index.constituents(symbol='BUK100P', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/index/constituent_choices", + "style": { + "popupWidth": 600 + } + } + } + } + } + ], + "cboe": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for. European indices return current-day constituent quotes; Cboe Australia (CXA) indices return the index composition with weights.", + "default": "BUK100P", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "session", + "type": "str | None", + "description": "Only valid for Cboe Australia (CXA) indices. 'eod' is the last close, 'sod' is the projected next-session open.", + "default": "eod", + "optional": true, + "choices": [ + "eod", + "sod" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "eod", + "sod" + ] + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeIndexConstituents", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the constituent company in the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "security_type", + "type": "str | None", + "description": "The type of security represented.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "Weight of the constituent in the index, as a normalized percentage. Only valid for Cboe Australia (CXA) indices.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "last_price", + "type": "float | None", + "description": "Last price for the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick", + "type": "str | None", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "datetime | None", + "description": "Last trade timestamp for the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Type of asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "str | None", + "description": "Market the constituent trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "Domicile of the constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the constituent is priced in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "ISIN of the constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sedol", + "type": "str | None", + "description": "SEDOL of the constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gics", + "type": "str | None", + "description": "GICS sub-industry code of the constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_state", + "type": "str | None", + "description": "Trading state of the constituent at capture.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_outstanding", + "type": "float | None", + "description": "Shares in issue used for the index calculation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "float_ratio", + "type": "float | None", + "description": "Free-float ratio applied to the market cap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adjustment_factor", + "type": "float | None", + "description": "Index adjustment factor applied to the market cap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_rate", + "type": "float | None", + "description": "Rate used to convert into the index currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "Total market capitalization of the constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adjusted_market_cap", + "type": "float | None", + "description": "Free-float adjusted market capitalization used for the weight.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeIndexConstituents", + "openapi_extra": { + "model": "CboeIndexConstituents" + } + }, + "/cboe/index/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical Cboe index levels, daily or one-minute.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily historical index levels.\nobb.cboe.index.historical(symbol='AAVE10RP', provider='cboe')\n# One-minute levels for the most recent trading day.\nobb.cboe.index.historical(symbol='BUK100P', interval='1m', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): cboe.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/index/symbol_choices", + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "1d" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeIndexHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "cboe": [ + { + "name": "calls_volume", + "type": "float | None", + "description": "Number of calls traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "puts_volume", + "type": "float | None", + "description": "Number of puts traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_options_volume", + "type": "float | None", + "description": "Total number of options traded during the most recent trading period. Only valid if interval is 1m.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeIndexHistorical", + "openapi_extra": { + "widget_config": { + "name": "Index History", + "params": [ + { + "paramName": "symbol", + "multiSelect": false, + "value": "VIX" + } + ], + "description": "Daily or intraday closing levels for a Cboe index.", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + }, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "pinned": "left", + "chartDataType": "category" + }, + { + "field": "close", + "headerName": "Close", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "open", + "headerName": "Open", + "cellDataType": "number", + "chartDataType": "excluded" + }, + { + "field": "high", + "headerName": "High", + "cellDataType": "number", + "chartDataType": "excluded" + }, + { + "field": "low", + "headerName": "Low", + "cellDataType": "number", + "chartDataType": "excluded" + } + ] + } + } + }, + "model": "CboeIndexHistorical" + } + }, + "/cboe/options/get_tickers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve expiry/strike dropdown choices for a symbol, loading it on first call.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "", + "optional": true + }, + { + "name": "expiry_list", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "strike_list", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/cboe/options/straddle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long straddle at each expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Straddle", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike_1", + "headerName": "Strike 1", + "cellDataType": "number" + }, + { + "field": "strike_2", + "headerName": "Strike 2", + "cellDataType": "number" + }, + { + "field": "strike_1_premium", + "headerName": "Strike 1 Premium", + "cellDataType": "number" + }, + { + "field": "strike_2_premium", + "headerName": "Strike 2 Premium", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_lower_percent", + "headerName": "Breakeven Lower %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + }, + { + "field": "breakeven_upper_percent", + "headerName": "Breakeven Upper %", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "" + } + }, + "/cboe/options/strangle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long strangle at each expiration for a given moneyness.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent out-of-the-money for both legs.", + "default": 5, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Strangle", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike_1", + "headerName": "Strike 1", + "cellDataType": "number" + }, + { + "field": "strike_2", + "headerName": "Strike 2", + "cellDataType": "number" + }, + { + "field": "strike_1_premium", + "headerName": "Strike 1 Premium", + "cellDataType": "number" + }, + { + "field": "strike_2_premium", + "headerName": "Strike 2 Premium", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_lower_percent", + "headerName": "Breakeven Lower %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + }, + { + "field": "breakeven_upper_percent", + "headerName": "Breakeven Upper %", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "" + } + }, + "/cboe/options/spreads": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price all four vertical spreads at each expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "spread_type", + "type": "str", + "description": "Vertical call spreads, put spreads, or both.", + "default": "both", + "optional": true + }, + { + "name": "near_moneyness", + "type": "float", + "description": "Percent out-of-the-money for the near leg.", + "default": 2.5, + "optional": true + }, + { + "name": "far_moneyness", + "type": "float", + "description": "Percent out-of-the-money for the far leg.", + "default": 7.5, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Spreads", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "strategy", + "headerName": "Strategy", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "expiration", + "headerName": "Expiration", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "sold_strike", + "headerName": "Sold Strike", + "cellDataType": "number" + }, + { + "field": "bought_strike", + "headerName": "Bought Strike", + "cellDataType": "number" + }, + { + "field": "sold_premium", + "headerName": "Sold Premium", + "cellDataType": "number" + }, + { + "field": "bought_premium", + "headerName": "Bought Premium", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_lower_percent", + "headerName": "Breakeven Lower %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + }, + { + "field": "breakeven_upper_percent", + "headerName": "Breakeven Upper %", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "" + } + }, + "/cboe/options/chains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Delayed Cboe options chains, with greeks and implied volatility.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The full options chain for a symbol.\nobb.cboe.options.chains(symbol='AAPL', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cboe/equity/symbol_choices", + "style": { + "popupWidth": 600 + } + } + } + } + } + ], + "cboe": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the company directories will be cached for24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeOptionsChains", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "underlying_symbol", + "type": "list[str] | None", + "description": "Underlying symbol for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_price", + "type": "list[float] | None", + "description": "Price of the underlying stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "contract_symbol", + "type": "list[str]", + "description": "Contract symbol for the option.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eod_date", + "type": "list[date] | None", + "description": "Date for which the options chains are returned.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "list[date]", + "description": "Expiration date of the contract.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dte", + "type": "list[int] | None", + "description": "Days to expiration of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strike", + "type": "list[float]", + "description": "Strike price of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "option_type", + "type": "list[str]", + "description": "Call or Put.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "contract_size", + "type": "list[Union[int, float]] | None", + "description": "Number of underlying units per contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "list[Union[int, float]] | None", + "description": "Open interest on the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "list[Union[int, float]] | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "theoretical_price", + "type": "list[float] | None", + "description": "Theoretical value of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_price", + "type": "list[float] | None", + "description": "Last trade price of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_size", + "type": "list[Union[int, float]] | None", + "description": "Last trade size of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "list[datetime] | None", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick", + "type": "list[str] | None", + "description": "Whether the last tick was up or down in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "list[float] | None", + "description": "Current bid price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_size", + "type": "list[Union[int, float]] | None", + "description": "Bid size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_time", + "type": "list[datetime] | None", + "description": "The timestamp of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "list[str] | None", + "description": "The exchange of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "list[float] | None", + "description": "Current ask price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_size", + "type": "list[Union[int, float]] | None", + "description": "Ask size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_time", + "type": "list[datetime] | None", + "description": "The timestamp of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "list[str] | None", + "description": "The exchange of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mark", + "type": "list[float] | None", + "description": "The mid-price between the latest bid and ask.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open", + "type": "list[float] | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_bid", + "type": "list[float] | None", + "description": "The opening bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_ask", + "type": "list[float] | None", + "description": "The opening ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "high", + "type": "list[float] | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_high", + "type": "list[float] | None", + "description": "The highest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_high", + "type": "list[float] | None", + "description": "The highest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "low", + "type": "list[float] | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_low", + "type": "list[float] | None", + "description": "The lowest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_low", + "type": "list[float] | None", + "description": "The lowest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close", + "type": "list[float] | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_size", + "type": "list[Union[int, float]] | None", + "description": "The closing trade size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_time", + "type": "list[datetime] | None", + "description": "The time of the closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid", + "type": "list[float] | None", + "description": "The closing bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_bid_size", + "type": "list[Union[int, float]] | None", + "description": "The closing bid size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid_time", + "type": "list[datetime] | None", + "description": "The time of the bid closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask", + "type": "list[float] | None", + "description": "The closing ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_size", + "type": "list[Union[int, float]] | None", + "description": "The closing ask size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_time", + "type": "list[datetime] | None", + "description": "The time of the ask closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "list[float] | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "list[float] | None", + "description": "The change in the price of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "list[float] | None", + "description": "Change, in normalized percentage points, of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "implied_volatility", + "type": "list[float] | None", + "description": "Implied volatility of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "delta", + "type": "list[float] | None", + "description": "Delta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "gamma", + "type": "list[float] | None", + "description": "Gamma of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "theta", + "type": "list[float] | None", + "description": "Theta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "vega", + "type": "list[float] | None", + "description": "Vega of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "rho", + "type": "list[float] | None", + "description": "Rho of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + } + ], + "cboe": [] + }, + "model": "CboeOptionsChains", + "openapi_extra": { + "widget_config": { + "name": "Chains", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike", + "headerName": "Strike", + "cellDataType": "number" + }, + { + "field": "option_type", + "headerName": "Type", + "cellDataType": "text" + }, + { + "field": "contract_symbol", + "headerName": "Contract", + "cellDataType": "text" + }, + { + "field": "open_interest", + "headerName": "OI", + "cellDataType": "number" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number" + }, + { + "field": "last_trade_price", + "headerName": "Last", + "cellDataType": "number" + }, + { + "field": "bid", + "headerName": "Bid", + "cellDataType": "number" + }, + { + "field": "ask", + "headerName": "Ask", + "cellDataType": "number" + }, + { + "field": "implied_volatility", + "headerName": "IV", + "cellDataType": "number" + }, + { + "field": "delta", + "headerName": "Delta", + "cellDataType": "number" + }, + { + "field": "gamma", + "headerName": "Gamma", + "cellDataType": "number" + }, + { + "field": "theta", + "headerName": "Theta", + "cellDataType": "number" + }, + { + "field": "vega", + "headerName": "Vega", + "cellDataType": "number" + }, + { + "field": "rho", + "headerName": "Rho", + "cellDataType": "number" + }, + { + "field": "underlying_symbol", + "headerName": "Underlying", + "cellDataType": "text" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + } + ] + } + } + }, + "model": "CboeOptionsChains" + } + }, + "/cboe/options/trade_optimizer": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Rank the option strategies that reach a target price by an expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "expiration", + "type": "str", + "description": "The expiration to trade.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The view the target price is derived from.", + "default": "neutral", + "optional": true + }, + { + "name": "target_price", + "type": "float", + "description": "An explicit target price, overriding the sentiment.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Trade Optimizer", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "strategy_label", + "headerName": "Strategy", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "expiry", + "headerName": "Expiration", + "cellDataType": "text" + }, + { + "field": "strike1", + "headerName": "Strike 1", + "cellDataType": "number" + }, + { + "field": "strike2", + "headerName": "Strike 2", + "cellDataType": "number" + }, + { + "field": "current_price", + "headerName": "Current Offer", + "cellDataType": "number" + }, + { + "field": "profit", + "headerName": "Profit At Target", + "cellDataType": "number" + }, + { + "field": "return", + "headerName": "Return At Target", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "annualized_return", + "headerName": "Annualized Return", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "prob_of_profit", + "headerName": "Probability Of Profit", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "prob_itm", + "headerName": "Probability ITM", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "prob_of_tgt_price", + "headerName": "Probability Of Target", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "regt_margin", + "headerName": "Reg-T Margin", + "cellDataType": "number" + }, + { + "field": "target_stock_price", + "headerName": "Target Price", + "cellDataType": "number" + } + ] + } + } + }, + "model": "" + } + }, + "/cboe/options/smile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility smile / skew across strikes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "expirations", + "type": "str", + "description": "Up to five expiration dates (comma-separated).", + "default": null, + "optional": true + }, + { + "name": "otm", + "type": "bool", + "description": "Show only out-of-the-money contracts.", + "default": false, + "optional": true + }, + { + "name": "skew", + "type": "bool", + "description": "Plot skew relative to ATM instead of IV.", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Cboe Options Smile", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/cboe/options/surface": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility or greeks 3-D surface over DTE and strike.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "The surface metric. Cboe publishes greeks alongside implied volatility.", + "default": "implied_volatility", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "Which side of the chain to plot.", + "default": "otm", + "optional": true + }, + { + "name": "dte_min", + "type": "int", + "description": "Minimum days to expiry.", + "default": null, + "optional": true + }, + { + "name": "dte_max", + "type": "int", + "description": "Maximum days to expiry.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent from the underlying price to include.", + "default": null, + "optional": true + }, + { + "name": "oi", + "type": "bool", + "description": "Drop contracts with no open interest.", + "default": false, + "optional": true + }, + { + "name": "volume", + "type": "bool", + "description": "Drop contracts that have not traded.", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Cboe Options Surface", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/cboe/options/stats": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open-interest or volume statistics by strike or expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "by", + "type": "str", + "description": "Aggregate by strike or expiration.", + "default": "expiration", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Open interest or volume.", + "default": "oi", + "optional": true + }, + { + "name": "date", + "type": "str", + "description": "Expiry to view by strike (switches 'by' to strike).", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Raw values, share of total, or put/call ratio.", + "default": "value", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Cboe Options Stats", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/cboe/options/term_structure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price or IV term structure across expirations.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM per expiry.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent out-of-the-money instead of a fixed strike.", + "default": null, + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Implied volatility or price.", + "default": "iv", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "Which side of the chain to plot.", + "default": "both", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Cboe Options Term Structure", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/cboe/options/payoff": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Draw the payoff of one optimized strategy at expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "SPY", + "optional": true + }, + { + "name": "expiration", + "type": "str", + "description": "The expiration to trade.", + "default": null, + "optional": true + }, + { + "name": "sentiment", + "type": "str", + "description": "The view the target price is derived from.", + "default": "neutral", + "optional": true + }, + { + "name": "strategy", + "type": "str", + "description": "The strategy to draw.", + "default": "buy_call_spread", + "optional": true + }, + { + "name": "target_price", + "type": "float", + "description": "An explicit target price, overriding the sentiment.", + "default": null, + "optional": true + }, + { + "name": "rank", + "type": "int", + "description": "Which ranked strategy to draw, best first.", + "default": 1, + "optional": true + }, + { + "name": "far_expiration", + "type": "str", + "description": "The long expiration of a calendar spread.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent out-of-the-money for each strangle wing.", + "default": 5, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Trade Optimizer Payoff", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/cboe/futures/settlement_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the settlement prices for Cboe futures contracts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Settlement prices for the most recent session.\nobb.cboe.futures.settlement_prices(provider='cboe')\n# Final settlement prices for expired contracts.\nobb.cboe.futures.settlement_prices(final_settlement=True, provider='cboe')\n```\n\n", + "parameters": { + "standard": [], + "cboe": [ + { + "name": "date", + "type": "date | None | str", + "description": "The settlement date. Sessions that settled nothing, such as weekends and holidays, fall back to the most recent session that did.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "options", + "type": "bool | None", + "description": "When True, returns options on futures.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "archives", + "type": "bool | None", + "description": "Settlement price archives for select years and products. Overridden by the other parameters.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "final_settlement", + "type": "bool | None", + "description": "Final settlement prices for expired contracts. Overrides archives.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeFuturesSettlements", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cboe": [ + { + "name": "product", + "type": "str | None", + "description": "The product family of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The contract symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str | None", + "description": "The expiration date of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The settlement price of the contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "duration_type", + "type": "str | None", + "description": "The duration classification of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_date", + "type": "date | None", + "description": "The session the prices settled on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_price", + "type": "float | None", + "description": "The final settlement price, for archived contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "settlement_month", + "type": "int | None", + "description": "The settlement month, for archived contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_year", + "type": "int | None", + "description": "The settlement year, for archived contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "The product type, for archived contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_description", + "type": "str | None", + "description": "The product description, for archived contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeFuturesSettlements", + "openapi_extra": { + "widget_config": { + "name": "Cboe Futures Settlement Prices", + "description": "Daily settlement prices. Sessions that settled nothing fall back to the most recent one that did.", + "category": "Derivatives", + "subCategory": "Futures", + "source": [ + "Cboe" + ], + "gridData": { + "w": 20, + "h": 12 + } + }, + "model": "CboeFuturesSettlements" + } + }, + "/cboe/futures/instruments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Cboe futures roots, names, and their underlying symbols.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List the Cboe futures roots and their underlying symbols.\nobb.cboe.futures.instruments(provider='cboe')\n```\n\n", + "parameters": { + "standard": [], + "cboe": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeFuturesInstruments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cboe": [ + { + "name": "future_root", + "type": "str", + "description": "The root symbol of the futures product.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the futures product.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "family", + "type": "str | None", + "description": "The product family.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying", + "type": "str | None", + "description": "The underlying symbol of the futures product.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeFuturesInstruments", + "openapi_extra": { + "widget_config": { + "name": "Cboe Futures Instruments", + "description": "The futures products Cboe lists, and what each tracks.", + "category": "Derivatives", + "subCategory": "Futures", + "source": [ + "Cboe" + ], + "gridData": { + "w": 20, + "h": 12 + } + }, + "model": "CboeFuturesInstruments" + } + }, + "/cboe/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the VIX (VX) futures term structure, at mid-morning TWAP or end-of-day levels.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The current VIX futures term structure.\nobb.cboe.futures.curve(provider='cboe')\n# The curve as of one or more historical dates.\nobb.cboe.futures.curve(symbol='VX_EOD', date='2024-06-25,2024-06-26', provider='cboe')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. Multiple items allowed for provider(s): cboe.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "cboe": { + "multiple_items_allowed": true + } + } + } + ], + "cboe": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for.Default is 'VX_EOD'. Entered dates return the data nearest to the entered date.\n 'VX_AM' = Mid-Morning TWAP Levels\n 'VX_EOD' = 4PM Eastern Time Levels", + "default": "VX_EOD", + "optional": true, + "choices": [ + "VX_AM", + "VX_EOD" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "VX_AM", + "VX_EOD" + ] + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CboeFuturesCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the futures contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + } + ], + "cboe": [ + { + "name": "expiration", + "type": "str | None", + "description": "Futures expiration month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CboeFuturesCurve", + "openapi_extra": { + "widget_config": { + "name": "VIX Futures Curve", + "description": "The VX term structure, at mid-morning TWAP or end-of-day levels.", + "category": "Derivatives", + "subCategory": "Futures", + "source": [ + "Cboe" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + }, + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "chartDataType": "category" + }, + { + "field": "price", + "headerName": "Price", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "symbol", + "headerName": "Symbol", + "cellDataType": "text", + "chartDataType": "excluded" + }, + { + "field": "date", + "headerName": "Date", + "cellDataType": "dateString", + "chartDataType": "excluded" + } + ] + } + } + }, + "model": "CboeFuturesCurve" + } + }, + "/cftc/cot_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search current Commitment of Traders Reports.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.cot_search(provider='cftc')\nobb.cftc.cot_search(query='gold', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "code", + "type": "str | None", + "description": "A string with the market contract code (can be partial).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "The report type to search within.", + "default": "legacy", + "optional": true, + "choices": [ + "legacy", + "disaggregated", + "financial", + "supplemental" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "futures_only", + "type": "bool | None", + "description": "Search the futures-only report. Default is False, for the combined report.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Filter by commodity group name. Underscores are replaced with spaces. E.g, 'natural_resources' -> 'NATURAL RESOURCES'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Agriculture", + "value": "agriculture" + }, + { + "label": "Financial Instruments", + "value": "financial_instruments" + }, + { + "label": "Natural Resources", + "value": "natural_resources" + } + ] + } + } + }, + { + "name": "subcategory", + "type": "str | None", + "description": "Filter by commodity subgroup name. Underscores are replaced with spaces. E.g, 'precious_metals' -> 'PRECIOUS METALS'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Base Metals", + "value": "base_metals" + }, + { + "label": "Chemicals", + "value": "chemicals" + }, + { + "label": "Currency", + "value": "currency" + }, + { + "label": "Currency Non Major", + "value": "currency_non_major" + }, + { + "label": "Dairy Products", + "value": "dairy_products" + }, + { + "label": "Digital Asset", + "value": "digital_asset" + }, + { + "label": "Digital Asset Non Major", + "value": "digital_asset_non_major" + }, + { + "label": "Electricity And Sources", + "value": "electricity_and_sources" + }, + { + "label": "Emissions", + "value": "emissions" + }, + { + "label": "Fertilizer", + "value": "fertilizer" + }, + { + "label": "Fiber", + "value": "fiber" + }, + { + "label": "Foodstuffs Softs", + "value": "foodstuffs_softs" + }, + { + "label": "Grains", + "value": "grains" + }, + { + "label": "Interest Rate Swaps", + "value": "interest_rate_swaps" + }, + { + "label": "Interest Rates Non Us Treasury", + "value": "interest_rates_non_us_treasury" + }, + { + "label": "Interest Rates Us Treasury", + "value": "interest_rates_us_treasury" + }, + { + "label": "Livestock Meat Products", + "value": "livestock_meat_products" + }, + { + "label": "Natural Gas And Products", + "value": "natural_gas_and_products" + }, + { + "label": "Oilseed And Products", + "value": "oilseed_and_products" + }, + { + "label": "Other Agricultural", + "value": "other_agricultural" + }, + { + "label": "Other Financial Instruments", + "value": "other_financial_instruments" + }, + { + "label": "Petroleum And Products", + "value": "petroleum_and_products" + }, + { + "label": "Precious Metals", + "value": "precious_metals" + }, + { + "label": "Stock Indices", + "value": "stock_indices" + }, + { + "label": "Weather", + "value": "weather" + }, + { + "label": "Wood Products", + "value": "wood_products" + }, + { + "label": "Yield Insurance", + "value": "yield_insurance" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcCotSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "code", + "type": "str", + "description": "CFTC market contract code of the report.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "code" + } + } + } + }, + { + "name": "name", + "type": "str", + "description": "Name of the underlying asset.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Category of the underlying asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subcategory", + "type": "str | None", + "description": "Subcategory of the underlying asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "The units for one contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commodity", + "type": "str | None", + "description": "Name of the commodity.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CftcCotSearch", + "openapi_extra": { + "widget_config": { + "name": "Commitment of Traders Search", + "description": "Search for CFTC Commitment of Traders (COT) report series.", + "category": "CFTC", + "subCategory": "COT", + "refetchInterval": false + }, + "model": "CftcCotSearch" + } + }, + "/cftc/cot": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Commitment of Traders Reports.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.cot(provider='cftc')\n# Get the latest report for all items classified as, GOLD.\nobb.cftc.cot(code='CFTC_088691', limit=1, provider='cftc')\n# Get the report for futures only.\nobb.cftc.cot(code='CFTC_088691', futures_only=True, limit=1, provider='cftc')\n# Filter the report down to a specific section.\nobb.cftc.cot(code='CFTC_088691', futures_only=True, measure='changes', limit=1, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "code", + "type": "str", + "description": "A string with the market code.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cftc/cot_choices", + "style": { + "popupWidth": 650 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Default is the most recent report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "The type of report to retrieve.", + "default": "legacy", + "optional": true, + "choices": [ + "legacy", + "disaggregated", + "financial", + "supplemental" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "measure", + "type": "str | None", + "description": "Filter columns by measure type. Open interest is always included.", + "default": "all", + "optional": true, + "choices": [ + "all", + "positions", + "changes", + "percent_of_oi", + "traders", + "concentration" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "futures_only", + "type": "bool | None", + "description": "Returns the futures-only report. Default is False, for the combined report.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Number of most recent reports to return. Default is all available.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcCot", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_week", + "type": "str | None", + "description": "Report week for the year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_and_exchange_names", + "type": "str | None", + "description": "Market and exchange names.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cftc_contract_market_code", + "type": "str | None", + "description": "CFTC contract market code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_market_code", + "type": "str | None", + "description": "CFTC market code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_region_code", + "type": "str | None", + "description": "CFTC region code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_commodity_code", + "type": "str | None", + "description": "CFTC commodity code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_contract_market_code_quotes", + "type": "str | None", + "description": "CFTC contract market code quotes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_market_code_quotes", + "type": "str | None", + "description": "CFTC market code quotes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_commodity_code_quotes", + "type": "str | None", + "description": "CFTC commodity code quotes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "cftc_subgroup_code", + "type": "str | None", + "description": "CFTC subgroup code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commodity_group", + "type": "str | None", + "description": "Commodity group name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commodity_subgroup", + "type": "str | None", + "description": "Commodity subgroup name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "futonly_or_combined", + "type": "str | None", + "description": "If the report is futures-only or combined.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "contract_units", + "type": "str | None", + "description": "Contract units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "contract_market_name", + "type": "str | None", + "description": "Short contract market name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest_all", + "type": "int | None", + "description": "Total open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest_old", + "type": "int | None", + "description": "Total open interest, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest_other", + "type": "int | None", + "description": "Total open interest, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_long_all", + "type": "int | None", + "description": "Non-commercial long positions, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_short_all", + "type": "int | None", + "description": "Non-commercial short positions, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_spread_all", + "type": "int | None", + "description": "Non-commercial spreading positions, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_long_old", + "type": "int | None", + "description": "Non-commercial long positions, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_short_old", + "type": "int | None", + "description": "Non-commercial short positions, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_spread", + "type": "int | None", + "description": "Non-commercial spreading positions, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_long_other", + "type": "int | None", + "description": "Non-commercial long positions, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_short_other", + "type": "int | None", + "description": "Non-commercial short positions, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_spread_1", + "type": "int | None", + "description": "Non-commercial spreading positions, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_long_all", + "type": "int | None", + "description": "Commercial long positions, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_short_all", + "type": "int | None", + "description": "Commercial short positions, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_long_old", + "type": "int | None", + "description": "Commercial long positions, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_short_old", + "type": "int | None", + "description": "Commercial short positions, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_long_other", + "type": "int | None", + "description": "Commercial long positions, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_short_other", + "type": "int | None", + "description": "Commercial short positions, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_merchant_positions_long", + "type": "int | None", + "description": "Producer/merchant long positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_merchant_positions_short", + "type": "int | None", + "description": "Producer/merchant short positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_merchant_positions_long_1", + "type": "int | None", + "description": "Producer/merchant long positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_merchant_positions_short_1", + "type": "int | None", + "description": "Producer/merchant short positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_merchant_positions_long_2", + "type": "int | None", + "description": "Producer/merchant long positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_merchant_positions_short_2", + "type": "int | None", + "description": "Producer/merchant short positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_long_all", + "type": "int | None", + "description": "Swap dealer long positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_short_all", + "type": "int | None", + "description": "Swap dealer short positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_spread_all", + "type": "int | None", + "description": "Swap dealer spreading positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_long_old", + "type": "int | None", + "description": "Swap dealer long positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_short_old", + "type": "int | None", + "description": "Swap dealer short positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_spread_old", + "type": "int | None", + "description": "Swap dealer spreading positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_long_other", + "type": "int | None", + "description": "Swap dealer long positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_short_other", + "type": "int | None", + "description": "Swap dealer short positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "swap_positions_spread_other", + "type": "int | None", + "description": "Swap dealer spreading positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_long_all", + "type": "int | None", + "description": "Managed money long positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_short_all", + "type": "int | None", + "description": "Managed money short positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_spread", + "type": "int | None", + "description": "Managed money spreading positions, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_long_old", + "type": "int | None", + "description": "Managed money long positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_short_old", + "type": "int | None", + "description": "Managed money short positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_spread_1", + "type": "int | None", + "description": "Managed money spreading positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_long_other", + "type": "int | None", + "description": "Managed money long positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_short_other", + "type": "int | None", + "description": "Managed money short positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "managed_money_positions_spread_2", + "type": "int | None", + "description": "Managed money spreading positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dealer_positions_long_all", + "type": "int | None", + "description": "Dealer/intermediary long positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dealer_positions_short_all", + "type": "int | None", + "description": "Dealer/intermediary short positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dealer_positions_spread_all", + "type": "int | None", + "description": "Dealer/intermediary spreading positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_manager_positions_long", + "type": "int | None", + "description": "Asset manager/institutional long positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_manager_positions_short", + "type": "int | None", + "description": "Asset manager/institutional short positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_manager_positions_spread", + "type": "int | None", + "description": "Asset manager/institutional spreading positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "leveraged_funds_positions_long", + "type": "int | None", + "description": "Leveraged funds long positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "leveraged_funds_positions_short", + "type": "int | None", + "description": "Leveraged funds short positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "leveraged_funds_positions_spread", + "type": "int | None", + "description": "Leveraged funds spreading positions, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_long", + "type": "int | None", + "description": "Other reportable long positions, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_short", + "type": "int | None", + "description": "Other reportable short positions, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_spread", + "type": "int | None", + "description": "Other reportable spreading positions, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_long_1", + "type": "int | None", + "description": "Other reportable long positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_short_1", + "type": "int | None", + "description": "Other reportable short positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_spread_1", + "type": "int | None", + "description": "Other reportable spreading positions, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_long_2", + "type": "int | None", + "description": "Other reportable long positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_short_2", + "type": "int | None", + "description": "Other reportable short positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_reportable_positions_spread_2", + "type": "int | None", + "description": "Other reportable spreading positions, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_long_all_non_cit", + "type": "int | None", + "description": "Non-commercial long positions excluding CIT, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_short_all_non_cit", + "type": "int | None", + "description": "Non-commercial short positions excluding CIT, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_commercial_positions_spread_all_non_cit", + "type": "int | None", + "description": "Non-commercial spreading positions excluding CIT, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_long_all_non_cit", + "type": "int | None", + "description": "Commercial long positions excluding CIT, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_positions_short_all_non_cit", + "type": "int | None", + "description": "Commercial short positions excluding CIT, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cit_positions_long_all", + "type": "int | None", + "description": "Commodity index trader (CIT) long positions, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cit_positions_short_all", + "type": "int | None", + "description": "Commodity index trader (CIT) short positions, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_reportable_positions_long_all", + "type": "int | None", + "description": "Total reportable long positions, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_reportable_positions_short", + "type": "int | None", + "description": "Total reportable short positions, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_reportable_positions_long_old", + "type": "int | None", + "description": "Total reportable long positions, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_reportable_positions_short_1", + "type": "int | None", + "description": "Total reportable short positions, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_reportable_positions_long_other", + "type": "int | None", + "description": "Total reportable long positions, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_reportable_positions_short_2", + "type": "int | None", + "description": "Total reportable short positions, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_reportable_positions_long_all", + "type": "int | None", + "description": "Non-reportable long positions, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_reportable_positions_short_all", + "type": "int | None", + "description": "Non-reportable short positions, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_reportable_positions_long_old", + "type": "int | None", + "description": "Non-reportable long positions, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_reportable_positions_short_old", + "type": "int | None", + "description": "Non-reportable short positions, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_reportable_positions_long_other", + "type": "int | None", + "description": "Non-reportable long positions, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_reportable_positions_short_other", + "type": "int | None", + "description": "Non-reportable short positions, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_open_interest_all", + "type": "int | None", + "description": "Weekly change in total open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_open_interest_all", + "type": "int | None", + "description": "Weekly change in total open interest, all contracts. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_non_commercial_long_all", + "type": "int | None", + "description": "Weekly change in non-commercial long positions. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_non_commercial_short_all", + "type": "int | None", + "description": "Weekly change in non-commercial short positions. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_non_commercial_spread_all", + "type": "int | None", + "description": "Weekly change in non-commercial spreading positions. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_commercial_long_all", + "type": "int | None", + "description": "Weekly change in commercial long positions. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_commercial_short_all", + "type": "int | None", + "description": "Weekly change in commercial short positions. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_producer_merchant_long", + "type": "int | None", + "description": "Weekly change in producer/merchant long positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_producer_merchant_short", + "type": "int | None", + "description": "Weekly change in producer/merchant short positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_swap_long_all", + "type": "int | None", + "description": "Weekly change in swap dealer long positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_swap_short_all", + "type": "int | None", + "description": "Weekly change in swap dealer short positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_swap_spread_all", + "type": "int | None", + "description": "Weekly change in swap dealer spreading positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_managed_money_long_all", + "type": "int | None", + "description": "Weekly change in managed money long positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_managed_money_short_all", + "type": "int | None", + "description": "Weekly change in managed money short positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_managed_money_spread", + "type": "int | None", + "description": "Weekly change in managed money spreading positions. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_dealer_long_all", + "type": "int | None", + "description": "Weekly change in dealer/intermediary long positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_dealer_short_all", + "type": "int | None", + "description": "Weekly change in dealer/intermediary short positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_dealer_spread_all", + "type": "int | None", + "description": "Weekly change in dealer/intermediary spreading positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_asset_manager_long", + "type": "int | None", + "description": "Weekly change in asset manager/institutional long positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_asset_manager_short", + "type": "int | None", + "description": "Weekly change in asset manager/institutional short positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_asset_manager_spread", + "type": "int | None", + "description": "Weekly change in asset manager/institutional spreading positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_leveraged_funds_long", + "type": "int | None", + "description": "Weekly change in leveraged funds long positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_leveraged_funds_short", + "type": "int | None", + "description": "Weekly change in leveraged funds short positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_leveraged_funds_spread", + "type": "int | None", + "description": "Weekly change in leveraged funds spreading positions. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_reportable_long", + "type": "int | None", + "description": "Weekly change in other reportable long positions. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_reportable_short", + "type": "int | None", + "description": "Weekly change in other reportable short positions. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_reportable_spread", + "type": "int | None", + "description": "Weekly change in other reportable spreading positions. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_non_commercial_long_all_non_cit", + "type": "int | None", + "description": "Weekly change in non-commercial long positions excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_non_commercial_short_all_non_cit", + "type": "int | None", + "description": "Weekly change in non-commercial short positions excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_non_commercial_spread_all_non_cit", + "type": "int | None", + "description": "Weekly change in non-commercial spreading positions excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_commercial_long_all_non_cit", + "type": "int | None", + "description": "Weekly change in commercial long positions excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_commercial_short_all_non_cit", + "type": "int | None", + "description": "Weekly change in commercial short positions excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_cit_long_all", + "type": "int | None", + "description": "Weekly change in commodity index trader long positions. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_cit_short_all", + "type": "int | None", + "description": "Weekly change in commodity index trader short positions. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_total_reportable_long_all", + "type": "int | None", + "description": "Weekly change in total reportable long positions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_total_reportable_short", + "type": "int | None", + "description": "Weekly change in total reportable short positions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_total_reportable_long_all", + "type": "int | None", + "description": "Weekly change in total reportable long positions. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_total_reportable_short_all", + "type": "int | None", + "description": "Weekly change in total reportable short positions. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_non_reportable_long_all", + "type": "int | None", + "description": "Weekly change in non-reportable long positions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_non_reportable_short_all", + "type": "int | None", + "description": "Weekly change in non-reportable short positions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_non_reportable_long_all", + "type": "int | None", + "description": "Weekly change in non-reportable long positions. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_non_reportable_short_all", + "type": "int | None", + "description": "Weekly change in non-reportable short positions. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest_pct_all", + "type": "float | None", + "description": "Percent of total open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_old", + "type": "float | None", + "description": "Percent of total open interest, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other", + "type": "float | None", + "description": "Percent of total open interest, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_long_all", + "type": "float | None", + "description": "Non-commercial long as percent of open interest, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_short_all", + "type": "float | None", + "description": "Non-commercial short as percent of open interest, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_spread", + "type": "float | None", + "description": "Non-commercial spreading as percent of open interest, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_long_old", + "type": "float | None", + "description": "Non-commercial long as percent of open interest, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_short_old", + "type": "float | None", + "description": "Non-commercial short as percent of open interest, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_spread_1", + "type": "float | None", + "description": "Non-commercial spreading as percent of open interest, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_long_other", + "type": "float | None", + "description": "Non-commercial long as percent of open interest, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_short_other", + "type": "float | None", + "description": "Non-commercial short as percent of open interest, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_spread_2", + "type": "float | None", + "description": "Non-commercial spreading as percent of open interest, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_long_all", + "type": "float | None", + "description": "Commercial long as percent of open interest, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_short_all", + "type": "float | None", + "description": "Commercial short as percent of open interest, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_long_old", + "type": "float | None", + "description": "Commercial long as percent of open interest, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_short_old", + "type": "float | None", + "description": "Commercial short as percent of open interest, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_long_other", + "type": "float | None", + "description": "Commercial long as percent of open interest, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_short_other", + "type": "float | None", + "description": "Commercial short as percent of open interest, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_producer_merchant_long", + "type": "float | None", + "description": "Producer/merchant long as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_producer_merchant_short", + "type": "float | None", + "description": "Producer/merchant short as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_producer_merchant_long_1", + "type": "float | None", + "description": "Producer/merchant long as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_producer_merchant_short_1", + "type": "float | None", + "description": "Producer/merchant short as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_producer_merchant_long_2", + "type": "float | None", + "description": "Producer/merchant long as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_producer_merchant_short_2", + "type": "float | None", + "description": "Producer/merchant short as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_long_all", + "type": "float | None", + "description": "Swap dealer long as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_short_all", + "type": "float | None", + "description": "Swap dealer short as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_spread_all", + "type": "float | None", + "description": "Swap dealer spreading as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_long_old", + "type": "float | None", + "description": "Swap dealer long as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_short_old", + "type": "float | None", + "description": "Swap dealer short as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_spread_old", + "type": "float | None", + "description": "Swap dealer spreading as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_long_other", + "type": "float | None", + "description": "Swap dealer long as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_short_other", + "type": "float | None", + "description": "Swap dealer short as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_swap_spread_other", + "type": "float | None", + "description": "Swap dealer spreading as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_long_all", + "type": "float | None", + "description": "Managed money long as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_short_all", + "type": "float | None", + "description": "Managed money short as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_spread", + "type": "float | None", + "description": "Managed money spreading as percent of open interest, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_long_old", + "type": "float | None", + "description": "Managed money long as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_short_old", + "type": "float | None", + "description": "Managed money short as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_spread_1", + "type": "float | None", + "description": "Managed money spreading as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_long_other", + "type": "float | None", + "description": "Managed money long as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_short_other", + "type": "float | None", + "description": "Managed money short as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_managed_money_spread_2", + "type": "float | None", + "description": "Managed money spreading as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_dealer_long_all", + "type": "float | None", + "description": "Dealer/intermediary long as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_dealer_short_all", + "type": "float | None", + "description": "Dealer/intermediary short as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_dealer_spread_all", + "type": "float | None", + "description": "Dealer/intermediary spreading as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_asset_manager_long", + "type": "float | None", + "description": "Asset manager/institutional long as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_asset_manager_short", + "type": "float | None", + "description": "Asset manager/institutional short as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_asset_manager_spread", + "type": "float | None", + "description": "Asset manager/institutional spreading as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_leveraged_funds_long", + "type": "float | None", + "description": "Leveraged funds long as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_leveraged_funds_short", + "type": "float | None", + "description": "Leveraged funds short as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_leveraged_funds_spread", + "type": "float | None", + "description": "Leveraged funds spreading as percent of open interest, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_long", + "type": "float | None", + "description": "Other reportable long as percent of open interest, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_short", + "type": "float | None", + "description": "Other reportable short as percent of open interest, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_spread", + "type": "float | None", + "description": "Other reportable spreading as percent of open interest, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_long_1", + "type": "float | None", + "description": "Other reportable long as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_short_1", + "type": "float | None", + "description": "Other reportable short as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_spread_1", + "type": "float | None", + "description": "Other reportable spreading as percent of open interest, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_long_2", + "type": "float | None", + "description": "Other reportable long as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_short_2", + "type": "float | None", + "description": "Other reportable short as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_other_reportable_spread_2", + "type": "float | None", + "description": "Other reportable spreading as percent of open interest, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_long_all_non_cit", + "type": "float | None", + "description": "Non-commercial long excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_short_all_non_cit", + "type": "float | None", + "description": "Non-commercial short excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_commercial_spread_all_non_cit", + "type": "float | None", + "description": "Non-commercial spreading excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_long_all_non_cit", + "type": "float | None", + "description": "Commercial long excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_commercial_short_all_non_cit", + "type": "float | None", + "description": "Commercial short excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_cit_long_all", + "type": "float | None", + "description": "Commodity index trader long as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_cit_short_all", + "type": "float | None", + "description": "Commodity index trader short as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_long_all_non_cit", + "type": "float | None", + "description": "Total reportable long excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_short_all_non_cit", + "type": "float | None", + "description": "Total reportable short excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_long_all_non_cit", + "type": "float | None", + "description": "Non-reportable long excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_short_all_non_cit", + "type": "float | None", + "description": "Non-reportable short excluding CIT as percent of open interest. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_long_all", + "type": "float | None", + "description": "Total reportable long as percent of open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_short", + "type": "float | None", + "description": "Total reportable short as percent of open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_long_old", + "type": "float | None", + "description": "Total reportable long as percent of open interest, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_short_1", + "type": "float | None", + "description": "Total reportable short as percent of open interest, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_long_other", + "type": "float | None", + "description": "Total reportable long as percent of open interest, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_total_reportable_short_2", + "type": "float | None", + "description": "Total reportable short as percent of open interest, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_long_all", + "type": "float | None", + "description": "Non-reportable long as percent of open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_short_all", + "type": "float | None", + "description": "Non-reportable short as percent of open interest, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_long_old", + "type": "float | None", + "description": "Non-reportable long as percent of open interest, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_short_old", + "type": "float | None", + "description": "Non-reportable short as percent of open interest, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_long_other", + "type": "float | None", + "description": "Non-reportable long as percent of open interest, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "open_interest_pct_non_reportable_short_other", + "type": "float | None", + "description": "Non-reportable short as percent of open interest, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "traders_total_all", + "type": "int | None", + "description": "Total number of reportable traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_old", + "type": "int | None", + "description": "Total number of reportable traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_other", + "type": "int | None", + "description": "Total number of reportable traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_long_all", + "type": "int | None", + "description": "Number of non-commercial long traders, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_short_all", + "type": "int | None", + "description": "Number of non-commercial short traders, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_spread_all", + "type": "int | None", + "description": "Number of non-commercial spreading traders, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_long_old", + "type": "int | None", + "description": "Number of non-commercial long traders, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_short_old", + "type": "int | None", + "description": "Number of non-commercial short traders, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_spread_old", + "type": "int | None", + "description": "Number of non-commercial spreading traders, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_long_other", + "type": "int | None", + "description": "Number of non-commercial long traders, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_short_other", + "type": "int | None", + "description": "Number of non-commercial short traders, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_spread_other", + "type": "int | None", + "description": "Number of non-commercial spreading traders, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_long_all", + "type": "int | None", + "description": "Number of commercial long traders, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_short_all", + "type": "int | None", + "description": "Number of commercial short traders, all contracts. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_long_old", + "type": "int | None", + "description": "Number of commercial long traders, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_short_old", + "type": "int | None", + "description": "Number of commercial short traders, old crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_long_other", + "type": "int | None", + "description": "Number of commercial long traders, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_short_other", + "type": "int | None", + "description": "Number of commercial short traders, other crop year. Legacy report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_producer_merchant_long_all", + "type": "int | None", + "description": "Number of producer/merchant long traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_producer_merchant_short_all", + "type": "int | None", + "description": "Number of producer/merchant short traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_producer_merchant_long_old", + "type": "int | None", + "description": "Number of producer/merchant long traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_producer_merchant_short_old", + "type": "int | None", + "description": "Number of producer/merchant short traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_producer_merchant_long_other", + "type": "int | None", + "description": "Number of producer/merchant long traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_producer_merchant_short_other", + "type": "int | None", + "description": "Number of producer/merchant short traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_long_all", + "type": "int | None", + "description": "Number of swap dealer long traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_short_all", + "type": "int | None", + "description": "Number of swap dealer short traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_spread_all", + "type": "int | None", + "description": "Number of swap dealer spreading traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_long_old", + "type": "int | None", + "description": "Number of swap dealer long traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_short_old", + "type": "int | None", + "description": "Number of swap dealer short traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_spread_old", + "type": "int | None", + "description": "Number of swap dealer spreading traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_long_other", + "type": "int | None", + "description": "Number of swap dealer long traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_short_other", + "type": "int | None", + "description": "Number of swap dealer short traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_swap_spread_other", + "type": "int | None", + "description": "Number of swap dealer spreading traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_long_all", + "type": "int | None", + "description": "Number of managed money long traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_short_all", + "type": "int | None", + "description": "Number of managed money short traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_spread_all", + "type": "int | None", + "description": "Number of managed money spreading traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_long_old", + "type": "int | None", + "description": "Number of managed money long traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_short_old", + "type": "int | None", + "description": "Number of managed money short traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_spread_old", + "type": "int | None", + "description": "Number of managed money spreading traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_long_other", + "type": "int | None", + "description": "Number of managed money long traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_short_other", + "type": "int | None", + "description": "Number of managed money short traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_managed_money_spread_other", + "type": "int | None", + "description": "Number of managed money spreading traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_dealer_long_all", + "type": "int | None", + "description": "Number of dealer/intermediary long traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_dealer_short_all", + "type": "int | None", + "description": "Number of dealer/intermediary short traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_dealer_spread_all", + "type": "int | None", + "description": "Number of dealer/intermediary spreading traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_asset_manager_long_all", + "type": "int | None", + "description": "Number of asset manager/institutional long traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_asset_manager_short_all", + "type": "int | None", + "description": "Number of asset manager/institutional short traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_asset_manager_spread", + "type": "int | None", + "description": "Number of asset manager/institutional spreading traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_leveraged_funds_long_all", + "type": "int | None", + "description": "Number of leveraged funds long traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_leveraged_funds_short_all", + "type": "int | None", + "description": "Number of leveraged funds short traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_leveraged_funds_spread", + "type": "int | None", + "description": "Number of leveraged funds spreading traders, all contracts. TFF report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_long_all", + "type": "int | None", + "description": "Number of other reportable long traders, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_short", + "type": "int | None", + "description": "Number of other reportable short traders, all contracts. Disaggregated/TFF reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_spread", + "type": "int | None", + "description": "Number of other reportable spreading traders, all contracts. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_long_old", + "type": "int | None", + "description": "Number of other reportable long traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_short_1", + "type": "int | None", + "description": "Number of other reportable short traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_spread_1", + "type": "int | None", + "description": "Number of other reportable spreading traders, old crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_long_other", + "type": "int | None", + "description": "Number of other reportable long traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_short_2", + "type": "int | None", + "description": "Number of other reportable short traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_other_reportable_spread_2", + "type": "int | None", + "description": "Number of other reportable spreading traders, other crop year. Disaggregated report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_long_all_non_cit", + "type": "int | None", + "description": "Number of non-commercial long traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_short_all_non_cit", + "type": "int | None", + "description": "Number of non-commercial short traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_non_commercial_spread_all_non_cit", + "type": "int | None", + "description": "Number of non-commercial spreading traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_long_all_non_cit", + "type": "int | None", + "description": "Number of commercial long traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_commercial_short_all_non_cit", + "type": "int | None", + "description": "Number of commercial short traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_cit_long_all", + "type": "int | None", + "description": "Number of commodity index trader long traders. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_cit_short_all", + "type": "int | None", + "description": "Number of commodity index trader short traders. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_long_all_non_cit", + "type": "int | None", + "description": "Total reportable long traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_short_all_non_cit", + "type": "int | None", + "description": "Total reportable short traders excluding CIT. Supplemental report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_long_all", + "type": "int | None", + "description": "Total number of reportable long traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_short_all", + "type": "int | None", + "description": "Total number of reportable short traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_long_old", + "type": "int | None", + "description": "Total number of reportable long traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_short_old", + "type": "int | None", + "description": "Total number of reportable short traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_long_other", + "type": "int | None", + "description": "Total number of reportable long traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "traders_total_reportable_short_other", + "type": "int | None", + "description": "Total number of reportable short traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_4_traders_long", + "type": "float | None", + "description": "Gross long position concentration of top 4 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_4_traders_short", + "type": "float | None", + "description": "Gross short position concentration of top 4 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_8_traders_long", + "type": "float | None", + "description": "Gross long position concentration of top 8 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_8_traders_short", + "type": "float | None", + "description": "Gross short position concentration of top 8 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_4_traders_long_all", + "type": "float | None", + "description": "Net long position concentration of top 4 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_4_traders_short_all", + "type": "float | None", + "description": "Net short position concentration of top 4 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_8_traders_long_all", + "type": "float | None", + "description": "Net long position concentration of top 8 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_8_traders_short_all", + "type": "float | None", + "description": "Net short position concentration of top 8 traders, all contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_4_traders_long_1", + "type": "float | None", + "description": "Gross long position concentration of top 4 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_4_traders_short_1", + "type": "float | None", + "description": "Gross short position concentration of top 4 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_8_traders_long_1", + "type": "float | None", + "description": "Gross long position concentration of top 8 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_8_traders_short_1", + "type": "float | None", + "description": "Gross short position concentration of top 8 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_4_traders_long_old", + "type": "float | None", + "description": "Net long position concentration of top 4 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_4_traders_short_old", + "type": "float | None", + "description": "Net short position concentration of top 4 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_8_traders_long_old", + "type": "float | None", + "description": "Net long position concentration of top 8 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_8_traders_short_old", + "type": "float | None", + "description": "Net short position concentration of top 8 traders, old crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_4_traders_long_2", + "type": "float | None", + "description": "Gross long position concentration of top 4 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_4_traders_short_2", + "type": "float | None", + "description": "Gross short position concentration of top 4 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_8_traders_long_2", + "type": "float | None", + "description": "Gross long position concentration of top 8 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_gross_top_8_traders_short_2", + "type": "float | None", + "description": "Gross short position concentration of top 8 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_4_traders_long_other", + "type": "float | None", + "description": "Net long position concentration of top 4 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_4_traders_short_other", + "type": "float | None", + "description": "Net short position concentration of top 4 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_8_traders_long_other", + "type": "float | None", + "description": "Net long position concentration of top 8 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "concentration_net_top_8_traders_short_other", + "type": "float | None", + "description": "Net short position concentration of top 8 traders, other crop year. Legacy/Disaggregated reports.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CftcCot", + "openapi_extra": { + "widget_config": { + "name": "Commitment of Traders", + "description": "CFTC Commitment of Traders (COT) reports.", + "category": "CFTC", + "subCategory": "COT", + "refetchInterval": false + }, + "model": "CftcCot" + } + }, + "/cftc/cot_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Score COT positioning against each trader group's own lookback range.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.cot_index(provider='cftc')\n# Score the index and bond markets against their own year.\nobb.cftc.cot_index(asset_class='indices_bonds', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "asset_class", + "type": "str | None", + "description": "Asset class of the curated markets to score.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "lookback_weeks", + "type": "int | None", + "description": "Weeks of history the score ranks the latest net position within. 52 puts each reading in its own one-year range.", + "default": 52, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "futures_only", + "type": "bool | None", + "description": "Score the futures-only report, the basis COT positioning work conventionally uses. False scores the combined futures-and-options report, whose larger open interest dilutes every net-to-open-interest share.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache each market's report history locally.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcCotIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "report_date", + "type": "date", + "description": "Date of the CFTC report the scores are taken from.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Report Date" + } + } + }, + { + "name": "market", + "type": "str", + "description": "Curated market name.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Market", + "cellDataType": "text" + } + } + }, + { + "name": "open_interest", + "type": "int | None", + "description": "Total open interest on the report date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Open Interest" + } + } + }, + { + "name": "large_specs", + "type": "float | None", + "description": "Large speculators' net position as a 0-100 score within its own lookback range. 0 is the range low, 100 the range high.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large Specs", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#b91c1c", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#15803d", + "fill": true + } + ] + } + } + } + }, + { + "name": "large_specs_change", + "type": "float | None", + "description": "Change in the large speculators' score since the prior report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large \u03941w", + "cellDataType": "number", + "decimalPlaces": 1 + } + } + }, + { + "name": "large_specs_net_pct_oi", + "type": "float | None", + "description": "Large speculators' net position as a percent of open interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large Net/OI %", + "cellDataType": "number", + "decimalPlaces": 2 + } + } + }, + { + "name": "large_specs_zone", + "type": "str | None", + "description": "Band the large speculators' score sits in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large Zone", + "cellDataType": "text" + } + } + }, + { + "name": "small_specs", + "type": "float | None", + "description": "Small speculators' net position as a 0-100 score within its own lookback range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small Specs", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#b91c1c", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#15803d", + "fill": true + } + ] + } + } + } + }, + { + "name": "small_specs_change", + "type": "float | None", + "description": "Change in the small speculators' score since the prior report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small \u03941w", + "cellDataType": "number", + "decimalPlaces": 1 + } + } + }, + { + "name": "small_specs_net_pct_oi", + "type": "float | None", + "description": "Small speculators' net position as a percent of open interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small Net/OI %", + "cellDataType": "number", + "decimalPlaces": 2 + } + } + }, + { + "name": "small_specs_zone", + "type": "str | None", + "description": "Band the small speculators' score sits in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small Zone", + "cellDataType": "text" + } + } + }, + { + "name": "commercials", + "type": "float | None", + "description": "Commercials' net position as a 0-100 score within its own lookback range. A high score is their least-hedged reading, not a bullish one.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commercials", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#15803d", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#b91c1c", + "fill": true + } + ] + } + } + } + }, + { + "name": "commercials_change", + "type": "float | None", + "description": "Change in the commercials' score since the prior report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm \u03941w", + "cellDataType": "number", + "decimalPlaces": 1 + } + } + }, + { + "name": "commercials_net_pct_oi", + "type": "float | None", + "description": "Commercials' net position as a percent of open interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm Net/OI %", + "cellDataType": "number", + "decimalPlaces": 2 + } + } + }, + { + "name": "commercials_zone", + "type": "str | None", + "description": "Band the commercials' score sits in, in hedging terms.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm Zone", + "cellDataType": "text" + } + } + } + ] + }, + "model": "CftcCotIndex", + "openapi_extra": { + "widget_config": { + "name": "COT Positioning Index", + "description": "Where each trader group's net position sits in its own lookback range, 0 to 100, across the curated futures universe. A high commercial score is their least-hedged reading, not a bullish one.", + "category": "CFTC", + "subCategory": "COT", + "refetchInterval": false + }, + "model": "CftcCotIndex" + } + }, + "/cftc/cot_movers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Rank this week's largest COT positioning score moves.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.cot_movers(provider='cftc')\n# This week's biggest moves in index and bond futures.\nobb.cftc.cot_movers(asset_class='indices_bonds', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "limit", + "type": "int | None", + "description": "Number of largest weekly score moves to return.", + "default": 8, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "Asset class of the curated markets to score.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "lookback_weeks", + "type": "int | None", + "description": "Weeks of history the score ranks the latest net position within. 52 puts each reading in its own one-year range.", + "default": 52, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "futures_only", + "type": "bool | None", + "description": "Score the futures-only report, the basis COT positioning work conventionally uses. False scores the combined futures-and-options report, whose larger open interest dilutes every net-to-open-interest share.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache each market's report history locally.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcCotMovers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "market", + "type": "str", + "description": "Market whose score moved.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Market", + "pinned": "left", + "cellDataType": "text" + } + } + }, + { + "name": "trader_group", + "type": "str", + "description": "Trader group whose score moved.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trader Group", + "cellDataType": "text" + } + } + }, + { + "name": "spec_score", + "type": "float | None", + "description": "A speculator group's 0-100 score this week, shading green as they crowd in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spec Score", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#b91c1c", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#15803d", + "fill": true + } + ] + } + } + } + }, + { + "name": "commercial_score", + "type": "float | None", + "description": "The commercials' 0-100 score this week, shading red as they hedge up.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm Score", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#15803d", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#b91c1c", + "fill": true + } + ] + } + } + } + }, + { + "name": "change", + "type": "float | None", + "description": "Change in the score from the prior week.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1w Change", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 0 + } + } + }, + { + "name": "signal", + "type": "str", + "description": "What the move did to that group's stance.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Signal", + "cellDataType": "text", + "width": 320 + } + } + } + ] + }, + "model": "CftcCotMovers", + "openapi_extra": { + "widget_config": { + "name": "COT Largest Changes", + "description": "This week's largest moves in positioning score, ranked by size, with what each move did to that trader group's stance.", + "category": "CFTC", + "subCategory": "COT", + "refetchInterval": false + }, + "model": "CftcCotMovers" + } + }, + "/cftc/cot_positioning": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Track one market's COT positioning week by week.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.cot_positioning(provider='cftc')\n# Weekly gold positioning, scored against its own year.\nobb.cftc.cot_positioning(code='CFTC_088691', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "code", + "type": "str | None", + "description": "CFTC contract market code to score, as printed on the search table.", + "default": "CFTC_13874+", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/cftc/cot_choices", + "style": { + "popupWidth": 650 + } + } + } + }, + { + "name": "lookback_weeks", + "type": "int | None", + "description": "Weeks each week's score ranks its net position within.", + "default": 52, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "futures_only", + "type": "bool | None", + "description": "Score the futures-only report, the basis COT positioning work conventionally uses. False scores the combined futures-and-options report, whose larger open interest dilutes every net-to-open-interest share.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcCotPositioning", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "report_date", + "type": "date", + "description": "Date of the CFTC report.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Report Date" + } + } + }, + { + "name": "open_interest", + "type": "int | None", + "description": "Total open interest on the report date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Open Interest" + } + } + }, + { + "name": "large_specs_net", + "type": "int | None", + "description": "Large speculators' net position, in contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large Net" + } + } + }, + { + "name": "large_specs_net_pct_oi", + "type": "float | None", + "description": "Large speculators' net position as a percent of open interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large Net/OI %", + "cellDataType": "number", + "decimalPlaces": 2 + } + } + }, + { + "name": "large_specs_score", + "type": "float | None", + "description": "Large speculators' 0-100 score within the trailing window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large Score", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#b91c1c", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#15803d", + "fill": true + } + ] + } + } + } + }, + { + "name": "small_specs_net", + "type": "int | None", + "description": "Small speculators' net position, in contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small Net" + } + } + }, + { + "name": "small_specs_net_pct_oi", + "type": "float | None", + "description": "Small speculators' net position as a percent of open interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small Net/OI %", + "cellDataType": "number", + "decimalPlaces": 2 + } + } + }, + { + "name": "small_specs_score", + "type": "float | None", + "description": "Small speculators' 0-100 score within the trailing window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Small Score", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#b91c1c", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#15803d", + "fill": true + } + ] + } + } + } + }, + { + "name": "commercials_net", + "type": "int | None", + "description": "Commercials' net position, in contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm Net" + } + } + }, + { + "name": "commercials_net_pct_oi", + "type": "float | None", + "description": "Commercials' net position as a percent of open interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm Net/OI %", + "cellDataType": "number", + "decimalPlaces": 2 + } + } + }, + { + "name": "commercials_score", + "type": "float | None", + "description": "Commercials' 0-100 score within the trailing window, on the same exposure scale as the specs. A high score is their most-hedged reading.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Comm Score", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 1, + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "between", + "range": { + "min": -1, + "max": 15 + }, + "color": "#15803d", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 15, + "max": 35 + }, + "color": "#86efac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 35, + "max": 65 + }, + "color": "#d4d4d8", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 65, + "max": 85 + }, + "color": "#ef8a80", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 85, + "max": 101 + }, + "color": "#b91c1c", + "fill": true + } + ] + } + } + } + } + ] + }, + "model": "CftcCotPositioning", + "openapi_extra": { + "widget_config": { + "name": "COT Positioning History", + "description": "One market's weekly COT history: each trader group's net position, its share of open interest, and its 0-100 score within the trailing window.", + "category": "CFTC", + "subCategory": "COT", + "refetchInterval": false + }, + "model": "CftcCotPositioning" + } + }, + "/cftc/swap_trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get swap transaction and pricing data disseminated by DTCC.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.swap_trades(provider='cftc')\n# Get USD SOFR swap transactions reported on a given date.\nobb.cftc.swap_trades(asset_class='rates', currency='USD', underlier='SOFR', action_type='NEWT', provider='cftc')\n# Get large cleared credit transactions.\nobb.cftc.swap_trades(asset_class='credits', cleared='Y', min_notional=50000000, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "asset_class", + "type": "str | None", + "description": "Asset class of the transactions. Only the two priceable classes are offered: rates, valued against the DTCC-reported curve, and forex. Credit index prints have their own CDS Index Trades endpoint.", + "default": "rates", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start of the report-date window (UTC). Default is the end date, a single day. Every day in the window is a separately published file, so a long window is a proportionally larger download.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None", + "description": "End of the report-date window (UTC). Default is the most recent date whose file holds transactions matching the query; a file is published every calendar day, but weekends and holidays carry almost none. Retained 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate-1d" + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "Filter by the leg 1 notional currency. E.g., 'USD'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "underlier", + "type": "str | None", + "description": "Filter by UPI underlier name, matched as a case-insensitive substring. E.g., 'SOFR'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "upi_fisn", + "type": "str | None", + "description": "Filter by UPI FISN, matched as a case-insensitive substring. E.g., 'Swap OIS'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ticker", + "type": "str | None", + "description": "Filter to the exact UPI ticker, the Unique Product Identifier the source's TICKER report keys on. E.g., 'QZXQ4R16245X' for a SOFR OIS. The window is answered by the source's search API, one filtered query across the date range, cached per day.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "action_type", + "type": "str | None", + "description": "Filter by action type. E.g., 'NEWT' for new trades.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "New", + "value": "NEWT" + }, + { + "label": "Modify", + "value": "MODI" + }, + { + "label": "Correct", + "value": "CORR" + }, + { + "label": "Terminate", + "value": "TERM" + }, + { + "label": "Error", + "value": "EROR" + }, + { + "label": "Revive", + "value": "REVI" + } + ] + } + } + }, + { + "name": "cleared", + "type": "bool | None", + "description": "Filter by whether the transaction is centrally cleared. True keeps cleared and intent-to-clear trades (Cleared 'Y' or 'I'); False keeps bilateral trades (Cleared 'N').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "trade_type", + "type": "str | None", + "description": "Filter by trade-type family, for the rates asset class: 'spot' and 'forward' are single-currency fixed-vs-floating swaps in a recognized curve family, split by whether the trade has already started; 'basis' floats two indices in the same currency against each other; 'cross_currency' floats two different currencies; 'inflation' is a zero-coupon swap of a fixed breakeven against a published price index. Ignored outside the rates asset class.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Spot", + "value": "spot" + }, + { + "label": "Forward", + "value": "forward" + }, + { + "label": "Basis", + "value": "basis" + }, + { + "label": "Cross-Currency", + "value": "cross_currency" + }, + { + "label": "Inflation", + "value": "inflation" + } + ] + } + } + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Filter out transactions with a leg 1 notional below this amount.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "max_notional", + "type": "float | None", + "description": "Filter out transactions with a leg 1 notional above this amount.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Number of transactions to return. Default is all matching.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the daily file locally, revalidating it against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcSwapTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "trade_key", + "type": "str | None", + "description": "Asset-class-qualified dissemination identifier, e.g. 'IR:4402189634000000101'. The qualifier keeps the 19-digit identifier out of IEEE-754 double range, which truncates it past its 16th digit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade", + "cellDataType": "text", + "formatterFn": "none", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "dissemination_identifier", + "valueField": "trade_key" + } + } + } + } + }, + { + "name": "action_type", + "type": "str | None", + "description": "Action performed on the transaction: NEWT, MODI, CORR, TERM, EROR, or REVI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Action type" + } + } + }, + { + "name": "event_type", + "type": "str | None", + "description": "Event giving rise to the report: TRAD, COMP, ETRM, NOVA, EXER, or CLRG.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Event type" + } + } + }, + { + "name": "event_timestamp", + "type": "datetime | None", + "description": "Event timestamp.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Event timestamp" + } + } + }, + { + "name": "amendment_indicator", + "type": "bool | None", + "description": "Amendment indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Amendment indicator" + } + } + }, + { + "name": "asset_class", + "type": "str | None", + "description": "Asset class of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Asset Class" + } + } + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name. Superseded by the UPI fields and no longer populated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Product name" + } + } + }, + { + "name": "cleared", + "type": "str | None", + "description": "Clearing status: Y (cleared), N (not cleared), or I (intent to clear).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cleared" + } + } + }, + { + "name": "mandatory_clearing_indicator", + "type": "bool | None", + "description": "Mandatory clearing indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mandatory clearing indicator" + } + } + }, + { + "name": "execution_timestamp", + "type": "datetime | None", + "description": "Execution Timestamp.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Execution Timestamp" + } + } + }, + { + "name": "effective_date", + "type": "date | None", + "description": "Effective Date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective Date" + } + } + }, + { + "name": "expiration_date", + "type": "date | None", + "description": "Expiration Date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Expiration Date" + } + } + }, + { + "name": "maturity_date_of_the_underlier", + "type": "date | None", + "description": "Maturity date of the underlier.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Maturity date of the underlier" + } + } + }, + { + "name": "non_standardized_term_indicator", + "type": "bool | None", + "description": "Non standardized term indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Non - standardized term indicator" + } + } + }, + { + "name": "platform_identifier", + "type": "str | None", + "description": "MIC of the execution venue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Platform identifier" + } + } + }, + { + "name": "prime_brokerage_transaction_indicator", + "type": "bool | None", + "description": "Prime brokerage transaction indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prime brokerage transaction indicator" + } + } + }, + { + "name": "block_trade_election_indicator", + "type": "bool | None", + "description": "Block trade election indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Block trade election indicator" + } + } + }, + { + "name": "large_notional_off_facility_swap_election_indicator", + "type": "bool | None", + "description": "Large notional off facility swap election indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Large notional off - facility swap election indicator" + } + } + }, + { + "name": "notional_amount_leg_1", + "type": "float | None", + "description": "Notional amount of leg 1. Values above the cap are disseminated at the cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional amount - Leg 1" + } + } + }, + { + "name": "notional_amount_leg_2", + "type": "float | None", + "description": "Notional amount of leg 2. Values above the cap are disseminated at the cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional amount - Leg 2" + } + } + }, + { + "name": "notional_currency_leg_1", + "type": "str | None", + "description": "Notional currency Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional currency - Leg 1" + } + } + }, + { + "name": "notional_currency_leg_2", + "type": "str | None", + "description": "Notional currency Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional currency - Leg 2" + } + } + }, + { + "name": "notional_quantity_leg_1", + "type": "float | None", + "description": "Notional quantity Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional quantity - Leg 1" + } + } + }, + { + "name": "notional_quantity_leg_2", + "type": "float | None", + "description": "Notional quantity Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional quantity - Leg 2" + } + } + }, + { + "name": "total_notional_quantity_leg_1", + "type": "float | None", + "description": "Total notional quantity Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total notional quantity - Leg 1" + } + } + }, + { + "name": "total_notional_quantity_leg_2", + "type": "float | None", + "description": "Total notional quantity Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total notional quantity - Leg 2" + } + } + }, + { + "name": "quantity_frequency_multiplier_leg_1", + "type": "float | None", + "description": "Quantity frequency multiplier Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quantity frequency multiplier - Leg 1" + } + } + }, + { + "name": "quantity_frequency_multiplier_leg_2", + "type": "float | None", + "description": "Quantity frequency multiplier Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quantity frequency multiplier - Leg 2" + } + } + }, + { + "name": "quantity_unit_of_measure_leg_1", + "type": "str | None", + "description": "Quantity unit of measure Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quantity unit of measure - Leg 1" + } + } + }, + { + "name": "quantity_unit_of_measure_leg_2", + "type": "str | None", + "description": "Quantity unit of measure Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quantity unit of measure - Leg 2" + } + } + }, + { + "name": "quantity_frequency_leg_1", + "type": "str | None", + "description": "Quantity frequency Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quantity frequency - Leg 1" + } + } + }, + { + "name": "quantity_frequency_leg_2", + "type": "str | None", + "description": "Quantity frequency Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quantity frequency - Leg 2" + } + } + }, + { + "name": "notional_amount_in_effect_on_associated_effective_date_leg_1", + "type": "str | None", + "description": "Notional amount in effect on associated effective date Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional amount in effect on associated effective date - Leg 1" + } + } + }, + { + "name": "notional_amount_in_effect_on_associated_effective_date_leg_2", + "type": "str | None", + "description": "Notional amount in effect on associated effective date Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional amount in effect on associated effective date - Leg 2" + } + } + }, + { + "name": "effective_date_of_the_notional_amount_leg_1", + "type": "str | None", + "description": "Effective date of the notional amount Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective date of the notional amount - Leg 1" + } + } + }, + { + "name": "effective_date_of_the_notional_amount_leg_2", + "type": "str | None", + "description": "Effective date of the notional amount Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective date of the notional amount - Leg 2" + } + } + }, + { + "name": "end_date_of_the_notional_amount_leg_1", + "type": "str | None", + "description": "End date of the notional amount Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "End date of the notional amount - Leg 1" + } + } + }, + { + "name": "end_date_of_the_notional_amount_leg_2", + "type": "str | None", + "description": "End date of the notional amount Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "End date of the notional amount - Leg 2" + } + } + }, + { + "name": "call_amount", + "type": "float | None", + "description": "Call amount.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Call amount" + } + } + }, + { + "name": "call_currency", + "type": "str | None", + "description": "Call currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Call currency" + } + } + }, + { + "name": "put_amount", + "type": "float | None", + "description": "Put amount.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Put amount" + } + } + }, + { + "name": "put_currency", + "type": "str | None", + "description": "Put currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Put currency" + } + } + }, + { + "name": "exchange_rate", + "type": "float | None", + "description": "Exchange rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Exchange rate" + } + } + }, + { + "name": "exchange_rate_basis", + "type": "str | None", + "description": "Exchange rate basis.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Exchange rate basis" + } + } + }, + { + "name": "first_exercise_date", + "type": "date | None", + "description": "First exercise date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "First exercise date" + } + } + }, + { + "name": "fixed_rate_leg_1", + "type": "float | None", + "description": "Fixed rate of leg 1, expressed as a decimal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate - Leg 1" + } + } + }, + { + "name": "fixed_rate_leg_2", + "type": "float | None", + "description": "Fixed rate of leg 2, expressed as a decimal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate - Leg 2" + } + } + }, + { + "name": "option_premium_amount", + "type": "float | None", + "description": "Option Premium Amount.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Option Premium Amount" + } + } + }, + { + "name": "option_premium_currency", + "type": "str | None", + "description": "Option Premium Currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Option Premium Currency" + } + } + }, + { + "name": "price", + "type": "float | None", + "description": "Price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Price" + } + } + }, + { + "name": "price_unit_of_measure", + "type": "str | None", + "description": "Price unit of measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Price unit of measure" + } + } + }, + { + "name": "spread_leg_1", + "type": "float | None", + "description": "Spread Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread - Leg 1" + } + } + }, + { + "name": "spread_leg_2", + "type": "float | None", + "description": "Spread Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread - Leg 2" + } + } + }, + { + "name": "spread_currency_leg_1", + "type": "str | None", + "description": "Spread currency Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread currency - Leg 1" + } + } + }, + { + "name": "spread_currency_leg_2", + "type": "str | None", + "description": "Spread currency Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread currency - Leg 2" + } + } + }, + { + "name": "strike_price", + "type": "float | None", + "description": "Strike Price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike Price" + } + } + }, + { + "name": "strike_price_currency_currency_pair", + "type": "str | None", + "description": "Strike price currency/currency pair.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike price currency/currency pair" + } + } + }, + { + "name": "post_priced_swap_indicator", + "type": "bool | None", + "description": "Post priced swap indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Post - priced swap indicator" + } + } + }, + { + "name": "price_currency", + "type": "str | None", + "description": "Price currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Price currency" + } + } + }, + { + "name": "price_notation", + "type": "str | None", + "description": "Price notation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Price notation" + } + } + }, + { + "name": "spread_notation_leg_1", + "type": "str | None", + "description": "Spread notation Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread notation - Leg 1" + } + } + }, + { + "name": "spread_notation_leg_2", + "type": "str | None", + "description": "Spread notation Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread notation - Leg 2" + } + } + }, + { + "name": "strike_price_notation", + "type": "str | None", + "description": "Strike price notation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike price notation" + } + } + }, + { + "name": "fixed_rate_day_count_convention_leg_1", + "type": "str | None", + "description": "ISO 20022 day count code for the leg 1 fixed rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate day count convention - leg 1" + } + } + }, + { + "name": "fixed_rate_day_count_convention_leg_2", + "type": "str | None", + "description": "ISO 20022 day count code for the leg 2 fixed rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate day count convention - leg 2" + } + } + }, + { + "name": "floating_rate_day_count_convention_leg_1", + "type": "str | None", + "description": "ISO 20022 day count code for the leg 1 floating rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate day count convention - leg 1" + } + } + }, + { + "name": "floating_rate_day_count_convention_leg_2", + "type": "str | None", + "description": "ISO 20022 day count code for the leg 2 floating rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate day count convention - leg 2" + } + } + }, + { + "name": "floating_rate_reset_frequency_period_leg_1", + "type": "str | None", + "description": "Floating rate reset frequency period leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate reset frequency period - leg 1" + } + } + }, + { + "name": "floating_rate_reset_frequency_period_leg_2", + "type": "str | None", + "description": "Floating rate reset frequency period leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate reset frequency period - leg 2" + } + } + }, + { + "name": "floating_rate_reset_frequency_period_multiplier_leg_1", + "type": "float | None", + "description": "Floating rate reset frequency period multiplier leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate reset frequency period multiplier - leg 1" + } + } + }, + { + "name": "floating_rate_reset_frequency_period_multiplier_leg_2", + "type": "float | None", + "description": "Floating rate reset frequency period multiplier leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate reset frequency period multiplier - leg 2" + } + } + }, + { + "name": "other_payment_amount", + "type": "str | None", + "description": "Other payment amount.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other payment amount" + } + } + }, + { + "name": "fixed_rate_payment_frequency_period_leg_1", + "type": "str | None", + "description": "Fixed rate payment frequency period Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate payment frequency period - Leg 1" + } + } + }, + { + "name": "floating_rate_payment_frequency_period_leg_1", + "type": "str | None", + "description": "Floating rate payment frequency period Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate payment frequency period - Leg 1" + } + } + }, + { + "name": "fixed_rate_payment_frequency_period_leg_2", + "type": "str | None", + "description": "Fixed rate payment frequency period Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate payment frequency period - Leg 2" + } + } + }, + { + "name": "floating_rate_payment_frequency_period_leg_2", + "type": "str | None", + "description": "Floating rate payment frequency period Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate payment frequency period - Leg 2" + } + } + }, + { + "name": "fixed_rate_payment_frequency_period_multiplier_leg_1", + "type": "float | None", + "description": "Fixed rate payment frequency period multiplier Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate payment frequency period multiplier - Leg 1" + } + } + }, + { + "name": "floating_rate_payment_frequency_period_multiplier_leg_1", + "type": "float | None", + "description": "Floating rate payment frequency period multiplier Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate payment frequency period multiplier - Leg 1" + } + } + }, + { + "name": "fixed_rate_payment_frequency_period_multiplier_leg_2", + "type": "float | None", + "description": "Fixed rate payment frequency period multiplier Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed rate payment frequency period multiplier - Leg 2" + } + } + }, + { + "name": "floating_rate_payment_frequency_period_multiplier_leg_2", + "type": "float | None", + "description": "Floating rate payment frequency period multiplier Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating rate payment frequency period multiplier - Leg 2" + } + } + }, + { + "name": "other_payment_type", + "type": "str | None", + "description": "Other payment type.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other payment type" + } + } + }, + { + "name": "other_payment_currency", + "type": "str | None", + "description": "Other payment currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Other payment currency" + } + } + }, + { + "name": "settlement_currency_leg_1", + "type": "str | None", + "description": "Settlement currency Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Settlement currency - Leg 1" + } + } + }, + { + "name": "settlement_currency_leg_2", + "type": "str | None", + "description": "Settlement currency Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Settlement currency - Leg 2" + } + } + }, + { + "name": "settlement_location", + "type": "str | None", + "description": "Settlement location.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Settlement location" + } + } + }, + { + "name": "collateralisation_category", + "type": "str | None", + "description": "Collateralisation category.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Collateralisation category" + } + } + }, + { + "name": "custom_basket_indicator", + "type": "bool | None", + "description": "Custom basket indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Custom basket indicator" + } + } + }, + { + "name": "index_factor", + "type": "float | None", + "description": "Index factor.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index factor" + } + } + }, + { + "name": "underlier_id_leg_1", + "type": "str | None", + "description": "Underlier ID Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlier ID - Leg 1" + } + } + }, + { + "name": "underlier_id_leg_2", + "type": "str | None", + "description": "Underlier ID Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlier ID - Leg 2" + } + } + }, + { + "name": "underlier_id_source_leg_1", + "type": "str | None", + "description": "Underlier ID source Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlier ID source - Leg 1" + } + } + }, + { + "name": "underlying_asset_name", + "type": "str | None", + "description": "Underlying Asset Name.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlying Asset Name" + } + } + }, + { + "name": "underlying_asset_subtype_or_underlying_contract_subtype_leg_1", + "type": "str | None", + "description": "Underlying asset subtype or underlying contract subtype Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlying asset subtype or underlying contract subtype - Leg 1" + } + } + }, + { + "name": "underlying_asset_subtype_or_underlying_contract_subtype_leg_2", + "type": "str | None", + "description": "Underlying asset subtype or underlying contract subtype Leg 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlying asset subtype or underlying contract subtype - Leg 2" + } + } + }, + { + "name": "embedded_option_type", + "type": "str | None", + "description": "Embedded Option type.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Embedded Option type" + } + } + }, + { + "name": "option_type", + "type": "str | None", + "description": "Option Type.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Option Type" + } + } + }, + { + "name": "option_style", + "type": "str | None", + "description": "Option Style.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Option Style" + } + } + }, + { + "name": "package_indicator", + "type": "bool | None", + "description": "Package indicator.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package indicator" + } + } + }, + { + "name": "package_transaction_price", + "type": "float | None", + "description": "Package transaction price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package transaction price" + } + } + }, + { + "name": "package_transaction_price_currency", + "type": "str | None", + "description": "Package transaction price currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package transaction price currency" + } + } + }, + { + "name": "package_transaction_price_notation", + "type": "str | None", + "description": "Package transaction price notation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package transaction price notation" + } + } + }, + { + "name": "package_transaction_spread", + "type": "float | None", + "description": "Package transaction spread.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package transaction spread" + } + } + }, + { + "name": "package_transaction_spread_currency", + "type": "str | None", + "description": "Package transaction spread currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package transaction spread currency" + } + } + }, + { + "name": "package_transaction_spread_notation", + "type": "str | None", + "description": "Package transaction spread notation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package transaction spread notation" + } + } + }, + { + "name": "physical_delivery_location_leg_1", + "type": "str | None", + "description": "Physical delivery location Leg 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Physical delivery location - Leg 1" + } + } + }, + { + "name": "delivery_type", + "type": "str | None", + "description": "Delivery Type.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Delivery Type" + } + } + }, + { + "name": "unique_product_identifier", + "type": "str | None", + "description": "ISO 4914 Unique Product Identifier (UPI).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unique Product Identifier" + } + } + }, + { + "name": "upi_fisn", + "type": "str | None", + "description": "Financial Instrument Short Name associated with the UPI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "UPI FISN" + } + } + }, + { + "name": "upi_underlier_name", + "type": "str | None", + "description": "Name of the underlier associated with the UPI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "UPI Underlier Name" + } + } + }, + { + "name": "is_capped", + "type": "bool | None", + "description": "Whether any amount on the transaction was disseminated at a reporting cap rather than its true value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Capped" + } + } + }, + { + "name": "trade_type", + "type": "str | None", + "description": "Trade-type family for a rates-asset-class print: 'spot', 'forward', 'basis', or 'cross_currency'. Not populated for other asset classes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade Type" + } + } + } + ] + }, + "model": "CftcSwapTrades", + "openapi_extra": { + "widget_config": { + "name": "Swap Transactions", + "description": "DTCC Public Price Dissemination swap transaction and pricing data.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcSwapTrades" + } + }, + "/cftc/swap_valuation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Value a disseminated swap on its own printed terms against the rate curve.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.swap_valuation(provider='cftc')\n# Value a specific disseminated print against today's curve.\nobb.cftc.swap_valuation(currency='USD', dissemination_identifier='4339565190000000401', provider='cftc')\n# Value the largest CNY print off its fixed-float IRS curve.\nobb.cftc.swap_valuation(currency='CNY', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency of the swap, priced off that currency's reported rate curve - its OIS, or its fixed-vs-floating IRS when it has no OIS (CNY, TWD, MYR, ...).", + "default": "USD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dissemination_identifier", + "type": "str | None", + "description": "The disseminated trade to value, as printed on the Swap Transactions tape. Any non-matured print is valuable by its own identifier. Default is the day's largest standalone par print; a package leg or off-par print's rate may reflect a package structure rather than a market level, flagged `is_vanilla_par` in the metadata rather than excluded.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "trade_date", + "type": "date | None", + "description": "Dissemination date the trade printed on (UTC). Default is the curve date, today's tape; an older print is looked up on the day it was disseminated and valued on its remaining life against the current curve. Slices are retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "side", + "type": "str | None", + "description": "Whether the position pays or receives the fixed rate. The net present value is signed to this side; dissemination does not say which side either counterparty took.", + "default": "pay", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Only consider prints at least this large when defaulting to the day's largest. Ignored when a dissemination identifier is given.", + "default": 0.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC) of the trades and the rate curve. Default is the most recent published. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Minimum trades for a curve node. The default keeps every traded tenor, because thin EM curves would otherwise lose their pillars.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcSwapValuation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "period", + "type": "int", + "description": "Coupon period, ordered from the first payment to maturity.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period" + } + } + }, + { + "name": "start_date", + "type": "date | str", + "description": "Start of the accrual period.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Start" + } + } + }, + { + "name": "payment_date", + "type": "date", + "description": "Payment date at the end of the accrual period.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Payment" + } + } + }, + { + "name": "year_fraction", + "type": "float", + "description": "Accrual year fraction of the period, on the currency's money-market day count.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year Frac", + "decimalPlaces": 4 + } + } + }, + { + "name": "discount_factor", + "type": "float", + "description": "Discount factor to the payment date, off the bootstrapped curve.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Discount Factor", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 6 + } + } + }, + { + "name": "forward_rate", + "type": "float | None", + "description": "Curve-implied forward rate for the period, in percent. Reported on the fixed leg's rows where the floating leg's periods align with them.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward Rate", + "cellDataType": "number", + "decimalPlaces": 4 + } + } + }, + { + "name": "floating_rate", + "type": "float | None", + "description": "Floating rate applied to the period, in percent - the curve's implied forward plus the contract spread.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating Rate", + "cellDataType": "number", + "decimalPlaces": 4 + } + } + }, + { + "name": "notional", + "type": "float", + "description": "Notional outstanding over the period, as the trade reported it - an amortising schedule steps down.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional" + } + } + }, + { + "name": "fixed_rate", + "type": "float", + "description": "Fixed rate applied to the period, in percent - the rate the trade printed at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed Rate", + "cellDataType": "number", + "decimalPlaces": 4 + } + } + }, + { + "name": "fixed_cashflow", + "type": "float", + "description": "Fixed-leg cash flow paid at the payment date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed Cashflow" + } + } + }, + { + "name": "fixed_pv", + "type": "float", + "description": "Present value of the fixed-leg cash flow.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fixed PV" + } + } + }, + { + "name": "floating_cashflow", + "type": "float | None", + "description": "Floating-leg cash flow at the period's forward rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating Cashflow" + } + } + }, + { + "name": "floating_pv", + "type": "float | None", + "description": "Present value of the floating-leg cash flow.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Floating PV" + } + } + }, + { + "name": "index_ratio", + "type": "float | None", + "description": "Total index ratio applied to the period on an inflation swap - the reference index at maturity over the trade's base index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Ratio", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 6 + } + } + }, + { + "name": "realized_ratio", + "type": "float | None", + "description": "The part of the index ratio already fixed by published index levels, on a seasoned inflation swap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Realized Ratio", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 6 + } + } + }, + { + "name": "projected_ratio", + "type": "float | None", + "description": "The part of the index ratio still projected off the curve's forward breakeven, on an inflation swap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Projected Ratio", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 6 + } + } + } + ] + }, + "model": "CftcSwapValuation", + "openapi_extra": { + "widget_config": { + "name": "Swap Valuation", + "description": "Fixed-rate swap valuation and cash-flow schedule against the DTCC-reported rate curve.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcSwapValuation" + } + }, + "/cftc/historical_fixings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily published fixings for a benchmark index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.historical_fixings(provider='cftc')\n# A year of 3-month EURIBOR fixings.\nobb.cftc.historical_fixings(index='EURIBOR', provider='cftc')\n# SOFR over a chosen window.\nobb.cftc.historical_fixings(index='SOFR', start_date='2026-01-01', end_date='2026-07-24', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "index", + "type": "str | None", + "description": "Published benchmark to return fixings for.", + "default": "SOFR", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "AONIA", + "value": "AONIA", + "extraInfo": { + "description": "AUD Overnight Index Average | AUS", + "rightOfDescription": "AUS" + } + }, + { + "label": "BBSW", + "value": "BBSW", + "extraInfo": { + "description": "Bank Bill Swap Rate (3M) | AUS", + "rightOfDescription": "AUS" + } + }, + { + "label": "CDI", + "value": "CDI", + "extraInfo": { + "description": "Interbank Deposit Certificate Rate | BRA", + "rightOfDescription": "BRA" + } + }, + { + "label": "CORRA", + "value": "CORRA", + "extraInfo": { + "description": "Canadian Overnight Repo Rate Average | CAN", + "rightOfDescription": "CAN" + } + }, + { + "label": "SARON", + "value": "SARON", + "extraInfo": { + "description": "Swiss Average Rate Overnight | CHE", + "rightOfDescription": "CHE" + } + }, + { + "label": "ICP", + "value": "ICP", + "extraInfo": { + "description": "Indice Camara Promedio | CHL", + "rightOfDescription": "CHL" + } + }, + { + "label": "FR007", + "value": "FR007", + "extraInfo": { + "description": "7-Day Fixing Repo Rate | CHN", + "rightOfDescription": "CHN" + } + }, + { + "label": "SHIBOR", + "value": "SHIBOR", + "extraInfo": { + "description": "Shanghai Interbank Offered Rate (O/N) | CHN", + "rightOfDescription": "CHN" + } + }, + { + "label": "SHIBOR3M", + "value": "SHIBOR3M", + "extraInfo": { + "description": "Shanghai Interbank Offered Rate (3M) | CHN", + "rightOfDescription": "CHN" + } + }, + { + "label": "IBR", + "value": "IBR", + "extraInfo": { + "description": "Indicador Bancario de Referencia | COL", + "rightOfDescription": "COL" + } + }, + { + "label": "PRIBOR", + "value": "PRIBOR", + "extraInfo": { + "description": "Prague Interbank Offered Rate (3M) | CZE", + "rightOfDescription": "CZE" + } + }, + { + "label": "ESTR", + "value": "ESTR", + "extraInfo": { + "description": "Euro Short-Term Rate | EMU", + "rightOfDescription": "EMU" + } + }, + { + "label": "EURIBOR", + "value": "EURIBOR", + "extraInfo": { + "description": "Euro Interbank Offered Rate (3M) | EMU", + "rightOfDescription": "EMU" + } + }, + { + "label": "SONIA", + "value": "SONIA", + "extraInfo": { + "description": "Sterling Overnight Index Average | GBR", + "rightOfDescription": "GBR" + } + }, + { + "label": "HIBOR", + "value": "HIBOR", + "extraInfo": { + "description": "Hong Kong Interbank Offered Rate (1M) | HKG", + "rightOfDescription": "HKG" + } + }, + { + "label": "BUBOR", + "value": "BUBOR", + "extraInfo": { + "description": "Budapest Interbank Offered Rate (3M) | HUN", + "rightOfDescription": "HUN" + } + }, + { + "label": "MIBOR", + "value": "MIBOR", + "extraInfo": { + "description": "Mumbai Interbank Outright Rate | IND", + "rightOfDescription": "IND" + } + }, + { + "label": "SHIR", + "value": "SHIR", + "extraInfo": { + "description": "Shekel Interbank Rate | ISR", + "rightOfDescription": "ISR" + } + }, + { + "label": "TONA", + "value": "TONA", + "extraInfo": { + "description": "Tokyo Overnight Average Rate | JPN", + "rightOfDescription": "JPN" + } + }, + { + "label": "KOFR", + "value": "KOFR", + "extraInfo": { + "description": "Korea Overnight Financing Repo Rate | KOR", + "rightOfDescription": "KOR" + } + }, + { + "label": "KRWCD", + "value": "KRWCD", + "extraInfo": { + "description": "Certificate of Deposit Rate (91-day) | KOR", + "rightOfDescription": "KOR" + } + }, + { + "label": "TIIE", + "value": "TIIE", + "extraInfo": { + "description": "Interbank Equilibrium Interest Rate | MEX", + "rightOfDescription": "MEX" + } + }, + { + "label": "KLIBOR", + "value": "KLIBOR", + "extraInfo": { + "description": "Kuala Lumpur Interbank Offered Rate (3M) | MYS", + "rightOfDescription": "MYS" + } + }, + { + "label": "MYOR", + "value": "MYOR", + "extraInfo": { + "description": "Malaysia Overnight Rate | MYS", + "rightOfDescription": "MYS" + } + }, + { + "label": "BKBM", + "value": "BKBM", + "extraInfo": { + "description": "Bank Bill Benchmark Rate (3M) | NZL", + "rightOfDescription": "NZL" + } + }, + { + "label": "NZIONA", + "value": "NZIONA", + "extraInfo": { + "description": "New Zealand Overnight Interbank Average | NZL", + "rightOfDescription": "NZL" + } + }, + { + "label": "POLSTR", + "value": "POLSTR", + "extraInfo": { + "description": "Polish Short-Term Rate | POL", + "rightOfDescription": "POL" + } + }, + { + "label": "WIBOR", + "value": "WIBOR", + "extraInfo": { + "description": "Warsaw Interbank Offered Rate (3M) | POL", + "rightOfDescription": "POL" + } + }, + { + "label": "SORA", + "value": "SORA", + "extraInfo": { + "description": "Singapore Overnight Rate Average | SGP", + "rightOfDescription": "SGP" + } + }, + { + "label": "THOR", + "value": "THOR", + "extraInfo": { + "description": "Thai Overnight Repurchase Rate | THA", + "rightOfDescription": "THA" + } + }, + { + "label": "TAIBOR", + "value": "TAIBOR", + "extraInfo": { + "description": "Taipei Interbank Offered Rate (3M) | TWN", + "rightOfDescription": "TWN" + } + }, + { + "label": "EFFR", + "value": "EFFR", + "extraInfo": { + "description": "Effective Federal Funds Rate | USA", + "rightOfDescription": "USA" + } + }, + { + "label": "SOFR", + "value": "SOFR", + "extraInfo": { + "description": "Secured Overnight Financing Rate | USA", + "rightOfDescription": "USA" + } + }, + { + "label": "JIBAR", + "value": "JIBAR", + "extraInfo": { + "description": "Johannesburg Interbank Average Rate (3M) | ZAF", + "rightOfDescription": "ZAF" + } + }, + { + "label": "ZARONIA", + "value": "ZARONIA", + "extraInfo": { + "description": "South African Rand Overnight Index Average | ZAF", + "rightOfDescription": "ZAF" + } + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the window. Default is one year back.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the window. Default is today.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the published fixings locally.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcHistoricalFixings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Effective date of the fixing.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Date" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Published fixing, as a percent.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rate", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 5, + "suffix": " %" + } + } + }, + { + "name": "change_bps", + "type": "float | None", + "description": "Change from the previous published fixing, in basis points.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Change (bps)", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 2 + } + } + } + ] + }, + "model": "CftcHistoricalFixings", + "openapi_extra": { + "widget_config": { + "name": "Historical Fixings", + "description": "Daily published fixings for a benchmark index, sourced from its own administrator, with the day-on-day change in basis points.", + "category": "CFTC", + "subCategory": "Rates", + "refetchInterval": false + }, + "model": "CftcHistoricalFixings" + } + }, + "/cftc/swap_summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Summarize a disseminated swap's net economics on the current curve.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.swap_summary(provider='cftc')\n# Summarize a specific disseminated print's net economics.\nobb.cftc.swap_summary(currency='USD', dissemination_identifier='4339565190000000401', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency of the swap, priced off that currency's reported rate curve - its OIS, or its fixed-vs-floating IRS when it has no OIS (CNY, TWD, MYR, ...).", + "default": "USD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dissemination_identifier", + "type": "str | None", + "description": "The disseminated trade to value, as printed on the Swap Transactions tape. Any non-matured print is valuable by its own identifier. Default is the day's largest standalone par print; a package leg or off-par print's rate may reflect a package structure rather than a market level, flagged `is_vanilla_par` in the metadata rather than excluded.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "trade_date", + "type": "date | None", + "description": "Dissemination date the trade printed on (UTC). Default is the curve date, today's tape; an older print is looked up on the day it was disseminated and valued on its remaining life against the current curve. Slices are retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "side", + "type": "str | None", + "description": "Whether the position pays or receives the fixed rate. The net present value is signed to this side; dissemination does not say which side either counterparty took.", + "default": "pay", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Only consider prints at least this large when defaulting to the day's largest. Ignored when a dissemination identifier is given.", + "default": 0.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC) of the trades and the rate curve. Default is the most recent published. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Minimum trades for a curve node. The default keeps every traded tenor, because thin EM curves would otherwise lose their pillars.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcSwapSummary", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "metric", + "type": "str", + "description": "Name of the summary metric.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metric", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "value", + "type": "str", + "description": "Value of the summary metric, formatted in its own unit.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Value", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "detail", + "type": "str | None", + "description": "Context the metric carries beyond its value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Detail", + "cellDataType": "text", + "formatterFn": "none" + } + } + } + ] + }, + "model": "CftcSwapSummary", + "openapi_extra": { + "widget_config": { + "name": "Swap Summary", + "description": "A disseminated swap's net economics right now: NPV against the current curve, realized carry from published fixings, upfront and other payments, and the side the trade currently favors.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcSwapSummary" + } + }, + "/cftc/cds_index_trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get credit default swap index transactions disseminated by DTCC.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.cds_index_trades(provider='cftc')\n# Get the CDX.NA.IG tape.\nobb.cftc.cds_index_trades(index='CDX.NA.IG', provider='cftc')\n# Get the 5Y CDX.NA.HY prints of at least 10mm notional.\nobb.cftc.cds_index_trades(index='CDX.NA.HY', tenor='5Y', min_notional=10000000, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "index", + "type": "str | None", + "description": "Filter by index family, matched against the UPI Underlier Name. E.g., 'CDX.NA.IG'. Matching is exact and case-insensitive, because 'ITRAXX EUROPE' is a substring of two other index families. Default is every index.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "CDX.NA.HY", + "value": "CDX.NA.HY" + }, + { + "label": "CDX.NA.IG", + "value": "CDX.NA.IG" + }, + { + "label": "ITRAXX EUROPE", + "value": "ITRAXX EUROPE" + }, + { + "label": "ITRAXX EUROPE CROSSOVER", + "value": "ITRAXX EUROPE CROSSOVER" + }, + { + "label": "CDX.EM", + "value": "CDX.EM" + }, + { + "label": "ITRAXX EUROPE SENIOR FINANCIALS", + "value": "ITRAXX EUROPE SENIOR FINANCIALS" + }, + { + "label": "CMBX.NA.BBB-", + "value": "CMBX.NA.BBB-" + }, + { + "label": "IBOXX USD LIQUID LEVERAGED LOANS INDEX", + "value": "IBOXX USD LIQUID LEVERAGED LOANS INDEX" + }, + { + "label": "ITRAXX ASIA EX-JAPAN IG", + "value": "ITRAXX ASIA EX-JAPAN IG" + }, + { + "label": "CMBX.NA.BB", + "value": "CMBX.NA.BB" + }, + { + "label": "ITRAXX JAPAN", + "value": "ITRAXX JAPAN" + }, + { + "label": "ITRAXX EUROPE SUB FINANCIALS", + "value": "ITRAXX EUROPE SUB FINANCIALS" + }, + { + "label": "CMBX.NA.AAA", + "value": "CMBX.NA.AAA" + }, + { + "label": "CDX.FINANCIALS", + "value": "CDX.FINANCIALS" + }, + { + "label": "ITRAXX AUSTRALIA", + "value": "ITRAXX AUSTRALIA" + } + ] + } + } + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). Default is the most recent date whose file holds index prints matching the query; a file is published every calendar day, but weekends and holidays carry almost none. Files are retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate-1d" + } + } + }, + { + "name": "tenor", + "type": "str | None", + "description": "Filter by the print's tenor at execution. E.g., '5Y'. Default is every tenor.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "1Y", + "value": "1Y" + }, + { + "label": "2Y", + "value": "2Y" + }, + { + "label": "3Y", + "value": "3Y" + }, + { + "label": "5Y", + "value": "5Y" + }, + { + "label": "7Y", + "value": "7Y" + }, + { + "label": "10Y", + "value": "10Y" + } + ] + } + } + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Filter out prints whose leg 1 notional is disseminated below this amount. A print above the reporting cap is disseminated at the cap, which is only a floor on its true size, so a threshold above a cap drops prints that may in fact exceed it. Caps vary by index, tenor and currency.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Number of prints to return. Default is all matching.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the daily file locally, revalidating it against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcCdsIndexTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "dissemination_date", + "type": "date", + "description": "Date the SDR publicly disseminated the print, being the report date of the file it was published in. The cumulative file carries no per-message dissemination timestamp.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dissemination Date" + } + } + }, + { + "name": "trade_key", + "type": "str | None", + "description": "Asset-class-qualified dissemination identifier, e.g. 'CR:4411567497000000101'. The qualifier keeps the 19-digit identifier out of IEEE-754 double range, which truncates it past its 16th digit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "action_type", + "type": "str | None", + "description": "Type of action taken on the swap transaction: NEWT (new), MODI (modify), CORR (correct), EROR (error), TERM (terminate), or REVI (revive).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Action Type", + "hide": true + } + } + }, + { + "name": "event_type", + "type": "str | None", + "description": "Explanation or reason for the action being taken on the swap transaction: TRAD (trade), NOVA (novation/step-in), COMP (compression or post trade risk reduction exercise), ETRM (early termination), CLRG (clearing), EXER (exercise), or CREV (credit event).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Event Type", + "hide": true + } + } + }, + { + "name": "event_timestamp", + "type": "datetime | None", + "description": "Date and time of occurrence of the event, as determined by the reporting counterparty or a service provider.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Event Timestamp", + "hide": true + } + } + }, + { + "name": "execution_timestamp", + "type": "datetime | None", + "description": "Date and time the transaction was originally executed, resulting in the generation of a new UTI. It remains unchanged throughout the life of the UTI, so on a correction or termination it dates the original trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Execution Timestamp" + } + } + }, + { + "name": "index", + "type": "str | None", + "description": "Name of the asset or index underlying the product corresponding to the UPI. It names the index family only and carries no series number, so `maturity_date` is what pins the series.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index" + } + } + }, + { + "name": "upi_fisn", + "type": "str | None", + "description": "ISO 18774 Financial Instrument Short Name issued by the UPI Service Provider. 'NA/CDS Corp Idx Tra' marks a tranche print.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "UPI FISN", + "hide": true + } + } + }, + { + "name": "unique_product_identifier", + "type": "str | None", + "description": "ISO 4914 Unique Product Identifier (UPI), a unique set of characters that represents a particular OTC derivative.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unique Product Identifier", + "hide": true + } + } + }, + { + "name": "effective_date", + "type": "date | None", + "description": "Unadjusted date at which obligations under the transaction come into effect. For a credit index this should be the effective date of the contract, usually one or two days after execution, and not the roll date of the underlying index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective Date", + "hide": true + } + } + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Unadjusted date at which obligations under the transaction stop being effective, as included in the confirmation ('Expiration date'). Early termination does not affect it. Together with `index` it identifies the series traded.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Maturity Date" + } + } + }, + { + "name": "tenor", + "type": "str | None", + "description": "Years from `execution_timestamp` to `maturity_date`, snapped to the nearest standard CDS index tenor within one year, else the rounded year count. Derived, not disseminated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "coupon", + "type": "float | None", + "description": "Per annum rate of the fixed leg, expressed as a decimal (0.05 is 500bp). The index's standardised coupon, and with `upfront_amount` the price of the print.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coupon" + } + } + }, + { + "name": "coupon_day_count", + "type": "str | None", + "description": "ISO 20022 day count convention of the fixed leg. A004 is ACT/360.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coupon Day Count", + "hide": true + } + } + }, + { + "name": "coupon_payment_frequency", + "type": "str | None", + "description": "Time unit associated with the frequency of fixed leg payments: DAIL, WEEK, MNTH, YEAR, ADHO, or EXPI (payment at term).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coupon Frequency", + "hide": true + } + } + }, + { + "name": "coupon_payment_frequency_multiplier", + "type": "float | None", + "description": "Number of time units of `coupon_payment_frequency` between payments. MNTH with a multiplier of 3 is quarterly.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Coupon Frequency Mult.", + "hide": true + } + } + }, + { + "name": "upfront_amount", + "type": "float | None", + "description": "Payment amount corresponding to `upfront_type`, in `upfront_currency`. With `coupon` it prices the print.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Upfront Amount" + } + } + }, + { + "name": "upfront_type", + "type": "str | None", + "description": "Type of the other payment amount. UFRO is an upfront payment: the initial payment made by one of the counterparties either to bring a transaction to fair value or for any other reason that may be the cause of an off-market transaction. UWIN is an unwind or full termination payment; PEXH is a principal exchange.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Upfront Type", + "hide": true + } + } + }, + { + "name": "upfront_currency", + "type": "str | None", + "description": "Currency in which `upfront_amount` is denominated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Upfront Currency", + "hide": true + } + } + }, + { + "name": "spread", + "type": "float | None", + "description": "Reported spread on the leg 1 index reference price, as disseminated. Conditional: it is required only where `coupon` is not populated and `upfront_type` is not 'UFRO', so it is an alternative to the coupon-plus-upfront quote rather than the price of the print. Read it together with `spread_notation` - the field also carries a price in points of par on the price-quoted indices. See the package README.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread" + } + } + }, + { + "name": "spread_notation", + "type": "str | None", + "description": "Manner in which `spread` is expressed: 1 (monetary amount, in `spread_currency`), 3 (decimal, e.g. 0.0257 for 2.57%), or 4 (basis points, e.g. 257 for 2.57%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread Notation", + "hide": true + } + } + }, + { + "name": "spread_currency", + "type": "str | None", + "description": "Currency in which `spread` is denominated. Only applicable when `spread_notation` is 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread Currency", + "hide": true + } + } + }, + { + "name": "index_factor", + "type": "float | None", + "description": "The index version factor or percent, expressed as a decimal value, that multiplied by the notional amount yields the notional amount covered by the seller of protection. Below 1 once a constituent has defaulted.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index Factor", + "hide": true + } + } + }, + { + "name": "notional_amount", + "type": "float | None", + "description": "Leg 1 notional amount specified in the contract, gross of any version incrementing due to a credit event. Values above the reporting cap are disseminated at the cap and flagged by `is_capped`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional" + } + } + }, + { + "name": "notional_currency", + "type": "str | None", + "description": "Currency in which the leg 1 notional amount is denominated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional Currency", + "hide": true + } + } + }, + { + "name": "is_capped", + "type": "bool | None", + "description": "Whether any amount on the print was disseminated at a reporting cap rather than its true value. Other disseminated amounts are proportionally scaled when the notional is capped.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Capped", + "hide": true + } + } + }, + { + "name": "venue", + "type": "str | None", + "description": "ISO 10383 segment MIC of the trading facility the transaction was executed on. XOFF marks a transaction in a listed instrument executed off venue, XXXX an instrument not listed on any venue, and BILT a reporting counterparty that could not determine whether the instrument is listed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venue" + } + } + }, + { + "name": "cleared", + "type": "str | None", + "description": "Whether the transaction has been cleared, or is intended to be cleared, by a central counterparty: Y (centrally cleared), N (not centrally cleared), or I (intent to clear, for original swaps planned to be submitted to clearing).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cleared" + } + } + }, + { + "name": "block_trade", + "type": "bool | None", + "description": "Whether an election has been made to report the transaction as a block trade, by the reporting counterparty or as calculated by the SDR on its behalf or by a third party.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Block Trade", + "hide": true + } + } + }, + { + "name": "package_trade", + "type": "bool | None", + "description": "Whether the transaction is part of a package transaction, being two or more transactions negotiated together as the product of a single economic agreement.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package", + "hide": true + } + } + } + ] + }, + "model": "CftcCdsIndexTrades", + "openapi_extra": { + "widget_config": { + "name": "CDS Index Trades", + "description": "DTCC Public Price Dissemination credit default swap index transactions.", + "category": "CFTC", + "subCategory": "Credit", + "refetchInterval": false + }, + "model": "CftcCdsIndexTrades" + } + }, + "/cftc/ois_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an overnight index swap curve, built from executed swap transactions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the USD SOFR curve.\nobb.cftc.ois_curve(provider='cftc')\n# Get the EUR ESTR curve.\nobb.cftc.ois_curve(currency='EUR', provider='cftc')\n# Fill in a thinly traded currency's short end, which needs a longer window and admits single prints.\nobb.cftc.ois_curve(currency='CHF', lookback_days=30, min_trades=1, provider='cftc')\n# Get the curve at every distinct tenor traded, not just benchmarks.\nobb.cftc.ois_curve(granularity='observed', min_trades=1, provider='cftc')\n# Build from a single day's file instead of a search window.\nobb.cftc.ois_curve(source='slice', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency of the swap curve. Each maps to that currency's overnight benchmark rate. Currencies whose overnight index swaps are too thinly reported to bootstrap a curve are not offered. CNY builds from FR007 fixed-float swaps, backstopped by the CFETS daily bulletin's traded curve.", + "default": "USD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "curve_type", + "type": "str | None", + "description": "Which representation of the curve to return in `rate`: the par swap rate or the annually compounded zero rate. The forward curve is a separate endpoint, `ois_forward_curve`.", + "default": "par", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Where the trades come from. 'search' queries a window of dissemination days and prices each tenor from the most recent day it traded in depth. 'slice' uses a single day's cumulative file, walking a weekend or holiday back to the most recent day that priced this currency, which still leaves sparse tenors missing.", + "default": "search", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). With source='search' this ends the lookback window, and defaults to today. With source='slice' it selects the most recent day on or before it that priced this currency, defaulting to the latest. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "lookback_days", + "type": "int | None", + "description": "Number of dissemination days to look back over, ending on `date`. With source='search' a longer window fills in more tenors, at the cost of pricing the thin ones further from today; check `staleness_days` and cap it with `max_staleness_days`. A thinly traded currency reaches a full curve only over a long window - the search chains 180-day sub-windows up to the one-year horizon. With source='slice' it is how far back to walk for the most recent day that priced this currency.", + "default": 7, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "max_staleness_days", + "type": "int | None", + "description": "Drop any node whose freshest print is older than this many days, measured from the curve's own date. A wide `lookback_days` fills thin tenors but resurrects some that last traded months ago in a different rate regime; capping staleness keeps the curve current rather than a mosaic of old levels. Only meaningful with source='search'. None keeps every live node and reports its age in `staleness_days`. Nodes that have already matured by the curve date are always dropped, cap or none.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "granularity", + "type": "str | None", + "description": "Tenor axis of the curve. 'benchmark' snaps trades to standard nodes; 'observed' emits a node for every distinct tenor traded, including broken dates.", + "default": "benchmark", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aggregation", + "type": "str | None", + "description": "How each node's executed rates are reduced to a par rate. Median is the default because notionals above the reporting cap are disseminated at the cap, which biases notional-weighted averages.", + "default": "median", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Drop nodes priced by fewer than this many trades on their as-of day. The default keeps every node, because one executed trade is still a price; `num_trades`, `min_rate` and `max_rate` say how thin it is. Raise it to admit only nodes several trades agree on, at the cost of losing the tenors a thin currency never trades in depth on any single day.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "cleared", + "type": "bool | None", + "description": "Keep only centrally cleared or intent-to-clear trades, dropping the bilateral uncleared prints that carry most of the off-market noise. Most useful with granularity='observed', where thin nodes are exposed to it.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interpolation", + "type": "str | None", + "description": "How discount factors are interpolated between pillars, on the log of the discount factor. 'log_linear' is piecewise linear, giving piecewise-flat instantaneous forwards. 'log_cubic' is a monotone Hermite cubic, giving smooth forwards without overshooting into negative rates.", + "default": "log_linear", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "overnight_anchor", + "type": "bool | None", + "description": "Anchor the curve's front end with the benchmark's latest published overnight fixing, as a 1-day node. The fixing is a realized rate, so the node carries no trades and its own as-of date.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally. Closed dissemination days are immutable and are never re-fetched; daily files are revalidated against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcOisCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Date of the curve, being that of its freshest node.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the curve.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Currency", + "chartDataType": "excluded" + } + } + }, + { + "name": "benchmark", + "type": "str", + "description": "Overnight benchmark rate the swaps reference (SOFR, ESTR, ...).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Benchmark", + "chartDataType": "excluded" + } + } + }, + { + "name": "index", + "type": "str", + "description": "Curve index plotted on the chart and used as the row index: the tenor label under 'benchmark' granularity, else the node's maturity date under 'observed' granularity.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "as_of_date", + "type": "date | None", + "description": "Dissemination date the node's trades were reported on. Nodes are priced from the most recent day that cleared min_trades, so a thin tenor is dated earlier than a deep one.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "As Of", + "chartDataType": "excluded" + } + } + }, + { + "name": "staleness_days", + "type": "int | None", + "description": "Days between the node's as-of date and the curve's date. Zero on the freshest nodes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Staleness (Days)", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "tenor", + "type": "str", + "description": "Tenor of the curve node.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor", + "cellDataType": "text", + "chartDataType": "excluded" + } + } + }, + { + "name": "tenor_days", + "type": "int", + "description": "Tenor of the node, in days.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor (Days)", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "tenor_years", + "type": "float", + "description": "Tenor of the node, in years, on an ACT/365F basis.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor (Years)", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "maturity_date", + "type": "date", + "description": "Maturity date implied by the node's tenor, from its as-of date. Under 'observed' granularity this is also the curve's index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Maturity Date", + "cellDataType": "date", + "chartDataType": "excluded" + } + } + }, + { + "name": "rate", + "type": "float | None", + "description": "Rate of the selected `curve_type` at the node, in percent (4.32 is 4.32%): the par swap rate or the annually compounded zero rate. In percent rather than a decimal so the chart axis reads as a rate - the grid formatter is not applied to the chart. Omitted where the bootstrap degenerates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rate", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent" + } + } + }, + { + "name": "curve_type", + "type": "str", + "description": "Which representation `rate` holds: par or zero.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Curve Type", + "chartDataType": "excluded" + } + } + }, + { + "name": "discount_factor", + "type": "float | None", + "description": "Discount factor bootstrapped to the node's maturity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Discount Factor", + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "none" + } + } + }, + { + "name": "day_count", + "type": "str | None", + "description": "Fixed-leg day count convention the node's trades reported, used to accrue the fixed leg in the bootstrap. ACT/360 for USD, EUR, CHF, MXN, COP and CLP; ACT/365F for GBP, JPY, CAD, SGD, INR, ZAR, THB, ILS, AUD and NZD. BRL reports BUS/252, recovered to the same year fraction on calendar days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Day Count", + "hide": true + } + } + }, + { + "name": "num_trades", + "type": "int", + "description": "Number of executed trades aggregated into the node.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trades", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "total_notional", + "type": "float | None", + "description": "Sum of the leg 1 notional of the node's trades.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Total Notional", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "min_rate", + "type": "float | None", + "description": "Lowest executed rate at the node, in percent (4.32 is 4.32%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Min Rate", + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "percent" + } + } + }, + { + "name": "max_rate", + "type": "float | None", + "description": "Highest executed rate at the node, in percent (4.32 is 4.32%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Max Rate", + "cellDataType": "number", + "chartDataType": "excluded", + "formatterFn": "percent" + } + } + }, + { + "name": "is_capped", + "type": "bool | None", + "description": "Whether any trade at the node had its notional disseminated at the reporting cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Capped" + } + } + } + ] + }, + "model": "CftcOisCurve", + "openapi_extra": { + "widget_config": { + "name": "Overnight Index Swap Curve", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "Central bank overnight index swap curves built from executed transactions.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcOisCurve" + } + }, + "/cftc/ois_curve_history": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an overnight index swap curve over time, as a date-by-tenor table.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.ois_curve_history(provider='cftc')\n# Track benchmark tenors over time.\nobb.cftc.ois_curve_history(tenor='2Y,5Y,10Y,30Y', provider='cftc')\n# Get the history of bootstrapped SONIA zero rates, in long form.\nobb.cftc.ois_curve_history(currency='GBP', measure='zero_rate', pivot=False, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency of the swap curve.", + "default": "USD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None", + "description": "Start date of the history. Default is 30 days before the end date. Files are retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate-30d" + } + } + }, + { + "name": "end_date", + "type": "date | None", + "description": "End date of the history. Default is the most recent date published.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate-1d" + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Curve measure to return for each tenor.", + "default": "par_rate", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "tenor", + "type": "str | None | list[str | None]", + "description": "Filter to specific benchmark tenors. Default is all tenors. E.g., '2Y,5Y,10Y'. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "aggregation", + "type": "str | None", + "description": "How each node's executed rates are reduced to a par rate.", + "default": "median", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Drop nodes priced by fewer than this many trades on a given date. The default keeps every node, because one executed trade is still a price.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interpolation", + "type": "str | None", + "description": "How discount factors are interpolated between pillars, on the log of the discount factor. 'log_linear' is piecewise linear; 'log_cubic' is a monotone Hermite cubic giving smooth forwards. Only affects zero_rate, discount_factor and forward_rate, not par_rate.", + "default": "log_linear", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pivot", + "type": "bool | None", + "description": "Return a date-by-tenor table. Set to False for flat, long-form rows.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the daily files locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcOisCurveHistory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Report date of the curve.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "tenor", + "type": "str | None", + "description": "Tenor of the observation. Returned when pivot is False.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "value", + "type": "float | None", + "description": "Value of the measure at the tenor, expressed as a decimal. Returned when pivot is False.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Value", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_1w", + "type": "float | None", + "description": "1W node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1W", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_2w", + "type": "float | None", + "description": "2W node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2W", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_1m", + "type": "float | None", + "description": "1M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_2m", + "type": "float | None", + "description": "2M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_3m", + "type": "float | None", + "description": "3M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_4m", + "type": "float | None", + "description": "4M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "4M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_6m", + "type": "float | None", + "description": "6M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_9m", + "type": "float | None", + "description": "9M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "9M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_1y", + "type": "float | None", + "description": "1Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_18m", + "type": "float | None", + "description": "18M node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "18M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_2y", + "type": "float | None", + "description": "2Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_3y", + "type": "float | None", + "description": "3Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_4y", + "type": "float | None", + "description": "4Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "4Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_5y", + "type": "float | None", + "description": "5Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "5Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_6y", + "type": "float | None", + "description": "6Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_7y", + "type": "float | None", + "description": "7Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "7Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_8y", + "type": "float | None", + "description": "8Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "8Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_9y", + "type": "float | None", + "description": "9Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "9Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_10y", + "type": "float | None", + "description": "10Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "10Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_12y", + "type": "float | None", + "description": "12Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "12Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_15y", + "type": "float | None", + "description": "15Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_20y", + "type": "float | None", + "description": "20Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "20Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_25y", + "type": "float | None", + "description": "25Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "25Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_30y", + "type": "float | None", + "description": "30Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_40y", + "type": "float | None", + "description": "40Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "40Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + }, + { + "name": "tenor_50y", + "type": "float | None", + "description": "50Y node of the curve, expressed as a decimal. Returned when pivot is True.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "50Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "normalizedPercent" + } + } + } + ] + }, + "model": "CftcOisCurveHistory", + "openapi_extra": { + "widget_config": { + "name": "Overnight Index Swap Curve History", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "Central bank overnight index swap curves over time, by tenor.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcOisCurveHistory" + } + }, + "/cftc/ois_forward_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the forward par swap rate curve, by forward start date.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.ois_forward_curve(provider='cftc')\n# Plot the 5Y forward rate at yearly start dates.\nobb.cftc.ois_forward_curve(forward_tenor='5Y', forward_step='1Y', provider='cftc')\n# Get the next ten years of the SONIA 1Y forward.\nobb.cftc.ois_forward_curve(currency='GBP', forward_tenor='1Y', forward_step='1Y', forward_count=10, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency of the swap curve.", + "default": "USD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "forward_tenor", + "type": "str | None", + "description": "Length of the forward swap - the tenor of the swap priced at each forward start date. Independent of the spacing between starts.", + "default": "1Y", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "forward_step", + "type": "str | None", + "description": "Spacing between forward start dates. Set it apart from `forward_tenor` to plot, say, the 5Y forward at yearly starts (forward_tenor='5Y', forward_step='1Y').", + "default": "3M", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "forward_count", + "type": "int | None", + "description": "Number of forward start dates to plot. Defaults to the whole curve out to its last pillar; set it to plot only the first N steps (e.g. 10 with a 1Y step is the next ten years of the forward).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "method", + "type": "str | None", + "description": "How the forward rates are formed. 'implied' reads them off the Nelson-Siegel-Svensson fit of the bootstrapped spot curve. 'observed' takes the fixed rates of the forward-starting swaps of the tenor directly, medianed by start and smoothed onto the grid - the market's own forward quotes, which reach only as far as that forward has traded.", + "default": "implied", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Where the trades come from. 'search' queries a window of dissemination days; 'slice' uses a single day's cumulative file, walking a weekend or holiday back to the most recent day that priced this currency.", + "default": "search", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). Ends the search window, or selects the most recent slice on or before it that priced this currency. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "lookback_days", + "type": "int | None", + "description": "Days to look back over: the search window with source='search', or how far to walk back for the most recent priced day with source='slice'. The search chains 180-day sub-windows up to the one-year horizon, so a thin currency can fill its forwards from a full year of prints.", + "default": 7, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "max_staleness_days", + "type": "int | None", + "description": "Drop any underlying node whose freshest print is older than this many days. A wide `lookback_days` fills thin tenors but resurrects some that last traded months ago; capping staleness keeps the forward strip current. Only meaningful with source='search'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aggregation", + "type": "str | None", + "description": "How each node's executed rates are reduced to a par rate.", + "default": "median", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Drop nodes priced by fewer than this many trades.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interpolation", + "type": "str | None", + "description": "Discount-factor interpolation for the bootstrap the Nelson-Siegel-Svensson forward fit is drawn from.", + "default": "log_linear", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcOisForwardCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Date of the curve.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the curve.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Currency", + "chartDataType": "excluded" + } + } + }, + { + "name": "index", + "type": "str", + "description": "Forward start date of the swap - the row and chart index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward Start", + "cellDataType": "date", + "chartDataType": "category" + } + } + }, + { + "name": "tenor", + "type": "str", + "description": "The forward swap and its start, e.g. '1Y @ 5.00Y' (a 1Y swap 5Y out).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward", + "cellDataType": "text", + "chartDataType": "excluded" + } + } + }, + { + "name": "start_years", + "type": "float", + "description": "Forward start of the swap, in years. 0 is spot.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Start (Years)", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "forward_rate", + "type": "float", + "description": "Forward par swap rate, in percent (4.32 is 4.32%).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward Rate", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent" + } + } + }, + { + "name": "extrapolated", + "type": "bool | None", + "description": "Whether the swap's tail ran past the last pillar, extended by the fit.", + "default": false, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extrapolated", + "hide": true + } + } + }, + { + "name": "num_trades", + "type": "int", + "description": "Trades behind the curve nodes spanning this forward's start-to-tenor span, or the nearest node's when none fall inside it.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trades", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "CftcOisForwardCurve", + "openapi_extra": { + "widget_config": { + "name": "OIS Forward Rate Curve", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "Forward par swap rate by start date, from executed transactions.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcOisForwardCurve" + } + }, + "/cftc/ois_policy_path": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the central bank's expected overnight-rate path from forward-starting OIS.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.ois_policy_path(provider='cftc')\n# The ECB path priced by EUR meeting-dated OIS.\nobb.cftc.ois_policy_path(currency='EUR', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency of the policy path, read from its forward-starting OIS. Only the currencies whose central banks trade meeting-dated OIS in depth are offered.", + "default": "USD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC) the path is built as of; defaults to the most recent. It anchors the forward start, so a window ending here is used and a trade whose start has since rolled to spot drops out.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "lookback_days", + "type": "int | None", + "description": "Number of recent daily files to combine, ending on `date`. Meeting-dated OIS are thin on any single day, so a handful of files are pooled to price each forward start in depth; a node's own freshest day is reported as `as_of_date`.", + "default": 10, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Drop a forward start priced by fewer than this many trades across the window. The default trims the one-off prints that are not meeting nodes.", + "default": 3, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcOisPolicyPath", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Date the path is built as of.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "currency", + "type": "str", + "description": "Currency of the path.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Currency", + "chartDataType": "excluded" + } + } + }, + { + "name": "index", + "type": "str", + "description": "Forward start date of the period - the row and chart index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward Start", + "cellDataType": "date", + "chartDataType": "category" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Expected average overnight rate over the period, in percent.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rate", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent" + } + } + }, + { + "name": "forward_days", + "type": "int", + "description": "Days from the curve date to the period's start.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward (Days)", + "chartDataType": "excluded" + } + } + }, + { + "name": "start_date", + "type": "date | str", + "description": "Start (effective date) of the period.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Start", + "chartDataType": "excluded" + } + } + }, + { + "name": "end_date", + "type": "date | str", + "description": "End (maturity) of the period.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "End", + "chartDataType": "excluded" + } + } + }, + { + "name": "tenor_days", + "type": "int", + "description": "Length of the period, in days.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor (Days)", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "num_trades", + "type": "int", + "description": "Trades pricing the node across the window.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trades", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "as_of_date", + "type": "date", + "description": "Freshest day the node's trades were disseminated on.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "As Of", + "chartDataType": "excluded" + } + } + }, + { + "name": "staleness_days", + "type": "int", + "description": "Days between the node's as-of day and the path's freshest node.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Staleness", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "min_rate", + "type": "float", + "description": "Lowest executed rate at the node, in percent.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Min Rate", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "max_rate", + "type": "float", + "description": "Highest executed rate at the node, in percent.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Max Rate", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "is_capped", + "type": "bool", + "description": "Whether any trade at the node had its notional disseminated at the cap.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Capped", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "CftcOisPolicyPath", + "openapi_extra": { + "widget_config": { + "name": "OIS Policy Path", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "Expected central-bank overnight-rate path, read from forward-starting OIS reported to the DTCC.", + "category": "CFTC", + "subCategory": "Swaps", + "refetchInterval": false + }, + "model": "CftcOisPolicyPath" + } + }, + "/cftc/fx_forward_points": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get FX forward points, built from executed forwards and FX swaps.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.fx_forward_points(provider='cftc')\n# Get USDJPY forward points.\nobb.cftc.fx_forward_points(pair='USDJPY', provider='cftc')\n# Include sub-institutional trades, which price away from the market.\nobb.cftc.fx_forward_points(pair='EURUSD', min_notional=0, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "pair", + "type": "str | None", + "description": "Currency pair, in market quoting convention. The USD/EM pairs (USDKRW, USDINR, USDBRL, ...) are non-deliverable forwards.", + "default": "EURUSD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Where the trades come from. 'search' queries a window of dissemination days and prices each tenor from the most recent day it traded in depth. 'slice' uses a single day's cumulative file, which leaves thin tenors missing and yields nothing on a weekend.", + "default": "search", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). With source='search' this ends the lookback window, and defaults to today. With source='slice' it selects one day's file, and defaults to the most recent published. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "lookback_days", + "type": "int | None", + "description": "Number of dissemination days to search back over, ending on `date`. Only used when source='search'. A longer window fills in more tenors, at the cost of pricing the thin ones further from today; check `staleness_days`. The source caps a search at 180 days.", + "default": 30, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Minimum trade notional, in the base currency. Sub-institutional prints trade percent away from the interbank market and would otherwise dominate a tenor's median. Set to 0 to keep every trade.", + "default": 1000000.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Drop tenors priced by fewer than this many trades. The default keeps every tenor, because one executed trade is still a price; `num_trades`, `min_rate` and `max_rate` say how thin it is.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally. Closed dissemination days are immutable and are never re-fetched; daily files are revalidated against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcFxForwardPoints", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Date of the curve, being that of its freshest tenor.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "as_of_date", + "type": "date | None", + "description": "Dissemination date the tenor's trades were reported on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "As Of", + "hide": true + } + } + }, + { + "name": "staleness_days", + "type": "int | None", + "description": "Days between the tenor's as-of date and the curve's date. Zero on the freshest tenors.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Staleness (Days)", + "hide": true + } + } + }, + { + "name": "pair", + "type": "str", + "description": "Currency pair, in market quoting convention.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pair", + "hide": true + } + } + }, + { + "name": "tenor", + "type": "str", + "description": "Tenor bucket of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "tenor_days", + "type": "int", + "description": "Lower bound of the tenor bucket, in days.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor (Days)", + "cellDataType": "number", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "spot_rate", + "type": "float", + "description": "Spot rate of the tenor's as-of date, the median of that day's trades settling within two days, or of its shortest-dated tenor for a non-deliverable pair.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spot", + "cellDataType": "number", + "decimalPlaces": 5 + } + } + }, + { + "name": "forward_rate", + "type": "float", + "description": "Median executed forward rate at the tenor.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward", + "cellDataType": "number", + "decimalPlaces": 5 + } + } + }, + { + "name": "forward_points", + "type": "float", + "description": "Executed forward rate less spot, in pips.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forward Points", + "cellDataType": "number", + "decimalPlaces": 4 + } + } + }, + { + "name": "theoretical_points", + "type": "float | None", + "description": "Covered-interest-parity forward points from the two legs' rate curves, in pips - each leg's OIS, or its fixed-float IRS for an EM currency with no OIS. Present only when both legs have a curve; for a non-deliverable pair its gap to the executed points (`basis_points`) is the NDF basis to onshore rates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "CIP Points", + "cellDataType": "number", + "decimalPlaces": 4 + } + } + }, + { + "name": "basis_points", + "type": "float | None", + "description": "Executed points less the CIP points, in pips: positive where the market pays over covered-interest-parity fair value, negative under.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Basis", + "cellDataType": "number", + "decimalPlaces": 4 + } + } + }, + { + "name": "quotation", + "type": "str | None", + "description": "Whether the base is at a forward premium (executed points positive, forward above spot) or a discount (points negative, forward below spot).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "carry", + "type": "str | None", + "description": "Whether a long base-currency forward position earns or pays the points to the forward date. It earns at a discount - the base out-yields the quote, so it is bought forward below spot - and pays at a premium. The short-base side is the opposite (Lehman Brothers, FX Training Manual: pay or earn the points).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "num_trades", + "type": "int", + "description": "Number of executed trades aggregated into the tenor.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trades" + } + } + }, + { + "name": "total_notional", + "type": "float | None", + "description": "Sum of the base currency notional of the tenor's trades.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "min_rate", + "type": "float | None", + "description": "Lowest executed rate aggregated into the tenor. A wide gap to `max_rate` marks a dispersed bucket whose median may be off-market - read it alongside `num_trades` before relying on the point.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Min Rate", + "cellDataType": "number", + "formatterFn": "none", + "decimalPlaces": 5 + } + } + }, + { + "name": "max_rate", + "type": "float | None", + "description": "Highest executed rate aggregated into the tenor. A wide gap to `min_rate` marks a dispersed bucket whose median may be off-market - read it alongside `num_trades` before relying on the point.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Max Rate", + "cellDataType": "number", + "decimalPlaces": 5 + } + } + } + ] + }, + "model": "CftcFxForwardPoints", + "openapi_extra": { + "widget_config": { + "name": "FX Forward Points", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "FX forward points built from executed forwards and FX swaps.", + "category": "CFTC", + "subCategory": "FX", + "refetchInterval": false + }, + "model": "CftcFxForwardPoints" + } + }, + "/cftc/fx_forward_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the outright FX forward curve, in units of the currency per one US dollar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.fx_forward_curve(provider='cftc')\n# Get the USDKRW forward curve, in KRW per US dollar.\nobb.cftc.fx_forward_curve(pair='USDKRW', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "pair", + "type": "str | None", + "description": "Currency pair. The curve is quoted as the foreign currency per one US dollar whichever way the pair is named. The USD/EM pairs (USDKRW, USDINR, ...) are non-deliverable forwards.", + "default": "USDJPY", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Where the trades come from. 'search' queries a window of dissemination days and prices each tenor from the most recent day it traded in depth; 'slice' uses a single day's cumulative file, which leaves thin tenors missing.", + "default": "search", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). With source='search' this ends the lookback window, defaulting to today. With source='slice' it selects the most recent day on or before it that priced this pair. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "lookback_days", + "type": "int | None", + "description": "Number of dissemination days to search back over, ending on `date`. Only used when source='search'. A longer window fills in more tenors, at the cost of pricing the thin ones further from today; check `staleness_days`.", + "default": 30, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Minimum trade notional, in the base currency. Set to 0 to keep every trade.", + "default": 1000000.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Drop tenors priced by fewer than this many trades.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcFxForwardCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Date of the curve.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "pair", + "type": "str", + "description": "Currency pair the curve is built for.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pair", + "chartDataType": "excluded" + } + } + }, + { + "name": "index", + "type": "str", + "description": "Settlement tenor of the node - the row and chart index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "tenor_days", + "type": "int", + "description": "Lower bound of the tenor bucket, in days.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tenor (Days)", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Outright forward rate, in units of the foreign currency per US dollar.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Per USD", + "cellDataType": "number", + "chartDataType": "series", + "decimalPlaces": 5, + "formatterFn": "none" + } + } + }, + { + "name": "spot", + "type": "float", + "description": "Spot rate of the tenor's as-of date, per US dollar.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spot", + "cellDataType": "number", + "chartDataType": "excluded", + "decimalPlaces": 5, + "formatterFn": "none" + } + } + }, + { + "name": "num_trades", + "type": "int", + "description": "Number of executed trades aggregated into the tenor.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trades", + "chartDataType": "excluded" + } + } + }, + { + "name": "total_notional", + "type": "float | None", + "description": "Sum of the base currency notional of the tenor's trades.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_rate", + "type": "float | None", + "description": "Lowest executed rate at the node, per US dollar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Min", + "cellDataType": "number", + "chartDataType": "excluded", + "decimalPlaces": 5, + "formatterFn": "none" + } + } + }, + { + "name": "max_rate", + "type": "float | None", + "description": "Highest executed rate at the node, per US dollar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Max", + "cellDataType": "number", + "chartDataType": "excluded", + "decimalPlaces": 5, + "formatterFn": "none" + } + } + }, + { + "name": "as_of_date", + "type": "date | None", + "description": "Dissemination date the tenor's trades were reported on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "As Of", + "chartDataType": "excluded" + } + } + }, + { + "name": "staleness_days", + "type": "int | None", + "description": "Days between the tenor's as-of date and the curve's date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Staleness", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "CftcFxForwardCurve", + "openapi_extra": { + "widget_config": { + "name": "FX Forward Curve", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "Outright FX forward curve, in units of the currency per US dollar, from executed forwards and FX swaps.", + "category": "CFTC", + "subCategory": "FX", + "refetchInterval": false + }, + "model": "CftcFxForwardCurve" + } + }, + "/cftc/fx_implied_vol": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get FX implied volatility from vanilla options disseminated by DTCC.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.fx_implied_vol(provider='cftc')\n# Get the USDJPY implied-volatility smile by tenor.\nobb.cftc.fx_implied_vol(pair='USDJPY', provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "pair", + "type": "str | None", + "description": "Currency pair, in market quoting convention. Limited to the pairs whose options are reported to the CFTC in enough depth to build a surface each day. The USD/EM pairs (USDBRL, USDKRW, ...) are built from non-deliverable options against a spot and forward taken from the reported non-deliverable forwards.", + "default": "EURUSD", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "basis", + "type": "str | None", + "description": "How the surface is built: 'empirical' medians the traded options at each grid strike (gaps where nothing traded); 'theoretical' fits a lognormal-SABR smile per expiry and evaluates it on the grid (smooth, gap-free).", + "default": "empirical", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC) of the options. Defaults to the most recent published. History is retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "min_trades", + "type": "int | None", + "description": "Minimum trades for an OIS curve node used to price the rate legs.", + "default": 3, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the source data locally, revalidating against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcFxImpliedVol", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "date", + "type": "date | str", + "description": "Dissemination date of the options.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "pair", + "type": "str", + "description": "Currency pair.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pair", + "chartDataType": "excluded" + } + } + }, + { + "name": "strike", + "type": "float", + "description": "Strike price of the underlying, on a grid of offsets from spot.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike", + "cellDataType": "number", + "chartDataType": "category", + "formatterFn": "none" + } + } + }, + { + "name": "strike_offset", + "type": "float", + "description": "The strike's distance from spot, positive above spot: in points for a deliverable major, in basis points of spot for a non-deliverable USD/EM pair.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Offset", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + }, + { + "name": "vol_1w", + "type": "float | None", + "description": "1-week implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1W", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_2w", + "type": "float | None", + "description": "2-week implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2W", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_1m", + "type": "float | None", + "description": "1-month implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_2m", + "type": "float | None", + "description": "2-month implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_3m", + "type": "float | None", + "description": "3-month implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "3M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_6m", + "type": "float | None", + "description": "6-month implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "6M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_9m", + "type": "float | None", + "description": "9-month implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "9M", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_1y", + "type": "float | None", + "description": "1-year implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "1Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "vol_2y", + "type": "float | None", + "description": "2-year implied volatility at the strike, in percent (5.4 is 5.4%).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2Y", + "cellDataType": "number", + "chartDataType": "series", + "formatterFn": "percent", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 5, + "color": "#2e7d32", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6.5 + }, + "color": "#7cb342", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6.5, + "max": 8 + }, + "color": "#c9a227", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 8, + "max": 11 + }, + "color": "#e07b1c", + "fill": true + }, + { + "condition": "gt", + "value": 11, + "color": "#c0392b", + "fill": true + } + ] + } + } + } + }, + { + "name": "num_options", + "type": "int", + "description": "Number of options aggregated into the strike row, across expiries.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Options", + "cellDataType": "number", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "CftcFxImpliedVol", + "openapi_extra": { + "widget_config": { + "name": "FX Implied Volatility", + "data": { + "chartView": { + "enabled": true, + "chartType": "line" + } + }, + "description": "FX implied-volatility smiles by tenor from vanilla options reported to the CFTC.", + "category": "CFTC", + "subCategory": "FX", + "refetchInterval": false + }, + "model": "CftcFxImpliedVol" + } + }, + "/cftc/fx_option_trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the raw FX option transactions disseminated by DTCC, newest first.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.fx_option_trades(provider='cftc')\n# Get the newly executed EURUSD option prints.\nobb.cftc.fx_option_trades(pair='EURUSD', action_type='NEWT', provider='cftc')\n# Get the non-deliverable option prints (BRL, KRW, INR, ...).\nobb.cftc.fx_option_trades(option_type='Non-Deliverable', provider='cftc')\n# Get the 20 largest JPY option prints of the day.\nobb.cftc.fx_option_trades(pair='JPY', min_notional=50000000, limit=20, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "pair", + "type": "str | None", + "description": "Filter to a pair or currency, matched against the two reported legs. 'EURUSD', 'EUR/USD' and 'EUR USD' all match EUR/USD; a single code like 'JPY' matches every pair with that leg. Default is every pair, deliverable and non-deliverable.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "option_type", + "type": "str | None", + "description": "Filter by option family: Vanilla, Non-Deliverable (cash-settled EM options), Digital, Barrier, or Target. Default is every family.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). Default is the most recent day whose file holds option prints; a file is published every calendar day, but weekends and holidays carry almost none. Files are retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "action_type", + "type": "str | None", + "description": "Filter by the action reported: NEWT (new), MODI (modify), CORR (correct), TERM (terminate), EROR (error), or REVI (revive). Default is every action; pass NEWT for newly executed trades only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "settlement_currency", + "type": "str | None", + "description": "Filter to options cash-settled in this currency, e.g. 'USD' for the USD-settled non-deliverable options. Deliverable options carry no settlement currency and are excluded by it. Default is every settlement.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Drop prints whose larger notional leg is disseminated below this amount. The two legs value the same trade in each currency, so the larger is a currency-agnostic size proxy. Amounts above the reporting cap disseminate at the cap.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ticker", + "type": "str | None", + "description": "Filter to the exact UPI ticker, the Unique Product Identifier the source's TICKER report keys on. Default is every product. A ticker query is answered by the source's search API, cached per day, not the daily files.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Number of prints to return, newest execution first. Default is all matching.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the daily file locally, revalidating it against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcFxOptionTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "event_timestamp", + "type": "datetime | None", + "description": "Date and time the reported event occurred, in UTC. The tape is ordered by it, newest first: a termination or correction of an old trade is dated when it is reported now, not when the trade was struck.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reported Time", + "sort": "desc" + } + } + }, + { + "name": "execution_timestamp", + "type": "datetime", + "description": "Date and time the option was originally executed, in UTC. It equals the reported time on a new trade, but predates it on an amendment or termination.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Executed" + } + } + }, + { + "name": "pair", + "type": "str", + "description": "Currency pair of the option, its two reported legs.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pair", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "option_type", + "type": "str | None", + "description": "Option family, read from the FISN: Vanilla, Non-Deliverable (cash-settled, `settlement_currency` is the payout leg), Digital, Barrier, or Target. Derived, not disseminated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Type", + "cellDataType": "text" + } + } + }, + { + "name": "action_type", + "type": "str | None", + "description": "Action reported: NEWT (new), MODI (modify), CORR (correct), TERM (terminate), EROR (error), or REVI (revive). An amendment carries the original trade's identifier in `original_trade_key`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Action" + } + } + }, + { + "name": "call_currency", + "type": "str | None", + "description": "Currency the option holder has the right to buy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Buy Ccy" + } + } + }, + { + "name": "call_amount", + "type": "float | None", + "description": "Notional of the currency bought, in `call_currency`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Buy Amount" + } + } + }, + { + "name": "put_currency", + "type": "str | None", + "description": "Currency the option holder has the right to sell.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sell Ccy" + } + } + }, + { + "name": "put_amount", + "type": "float | None", + "description": "Notional of the currency sold, in `put_currency`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sell Amount" + } + } + }, + { + "name": "strike", + "type": "float | None", + "description": "Strike price of the option, oriented as `strike_pair` states.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike", + "formatterFn": "none" + } + } + }, + { + "name": "strike_pair", + "type": "str | None", + "description": "Quotation the strike is expressed in, e.g. 'EUR/USD'. When absent, the strike follows `exchange_rate_basis`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike Pair" + } + } + }, + { + "name": "strike_notation", + "type": "str | None", + "description": "Format the strike is expressed in, per the CFTC Part 43/45 spec: 1 (a price, i.e. the exchange rate) or 3 (a decimal).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Strike Notation", + "hide": true + } + } + }, + { + "name": "expiration_date", + "type": "date | None", + "description": "Date the option expires.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Expiry" + } + } + }, + { + "name": "days_to_expiry", + "type": "int | None", + "description": "Calendar days from execution to expiration.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Days to Expiry", + "cellDataType": "number" + } + } + }, + { + "name": "premium_amount", + "type": "float | None", + "description": "Option premium paid, in `premium_currency`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Premium" + } + } + }, + { + "name": "premium_currency", + "type": "str | None", + "description": "Currency the premium is denominated in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Premium Ccy" + } + } + }, + { + "name": "settlement_currency", + "type": "str | None", + "description": "Currency a cash-settled option pays out in. Populated for non-deliverable options, whose non-deliverable leg settles in this currency rather than delivering.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Settlement Ccy" + } + } + }, + { + "name": "cleared", + "type": "str | None", + "description": "Whether the transaction is centrally cleared: Y (cleared), N (not cleared), or I (intent to clear).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cleared" + } + } + }, + { + "name": "venue", + "type": "str | None", + "description": "ISO 10383 segment MIC of the trading facility, or BILT when the reporting counterparty could not determine the venue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venue" + } + } + }, + { + "name": "exchange_rate", + "type": "float | None", + "description": "Posted exchange rate on the trade, oriented as `exchange_rate_basis` states. A proxy for spot at execution, the pricing reference for the strike.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Exchange Rate", + "formatterFn": "none" + } + } + }, + { + "name": "exchange_rate_basis", + "type": "str | None", + "description": "Quotation the exchange rate is expressed in, e.g. 'EUR/USD'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Exchange Rate Basis" + } + } + }, + { + "name": "notional_1", + "type": "float | None", + "description": "Leg 1 notional, in `notional_currency_1`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional 1", + "hide": true + } + } + }, + { + "name": "notional_currency_1", + "type": "str | None", + "description": "Currency of the leg 1 notional.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional Ccy 1", + "hide": true + } + } + }, + { + "name": "notional_2", + "type": "float | None", + "description": "Leg 2 notional, in `notional_currency_2`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional 2", + "hide": true + } + } + }, + { + "name": "notional_currency_2", + "type": "str | None", + "description": "Currency of the leg 2 notional.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional Ccy 2", + "hide": true + } + } + }, + { + "name": "effective_date", + "type": "date | None", + "description": "Date the option comes into effect.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective Date" + } + } + }, + { + "name": "first_exercise_date", + "type": "date | None", + "description": "First date the option may be exercised.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "First Exercise" + } + } + }, + { + "name": "event_type", + "type": "str | None", + "description": "Reason for the action: TRAD (trade), NOVA (novation), ETRM (early termination), EXER (exercise), or CLRG (clearing).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Event Type", + "hide": true + } + } + }, + { + "name": "block_trade", + "type": "bool | None", + "description": "Whether the print is reported as a block trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Block Trade", + "hide": true + } + } + }, + { + "name": "prime_brokerage", + "type": "bool | None", + "description": "Whether the transaction is a prime-brokerage transaction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prime Brokerage", + "hide": true + } + } + }, + { + "name": "package_trade", + "type": "bool | None", + "description": "Whether the print is one leg of a package transaction - a strategy (straddle, risk reversal, calendar spread, ...) whose legs are negotiated and priced together.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package" + } + } + }, + { + "name": "package_id", + "type": "str | None", + "description": "Grouping key shared by the legs of one package - its execution time and package price or spread. Group on it to reassemble a strategy. Derived, not disseminated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package ID" + } + } + }, + { + "name": "package_price", + "type": "float | None", + "description": "Price of the whole package, in the format `package_price_notation` states; the same on every leg. Present on price-quoted packages, where DTCC's 9.9999999999 not-provided placeholder has been dropped to null.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Price", + "formatterFn": "none" + } + } + }, + { + "name": "package_price_currency", + "type": "str | None", + "description": "Currency the package price is denominated in, when it is a monetary amount.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Price Ccy" + } + } + }, + { + "name": "package_price_notation", + "type": "str | None", + "description": "Format of `package_price`: 1 (a monetary amount, in `package_price_currency`) or 3 (a decimal).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Price Notation" + } + } + }, + { + "name": "package_spread", + "type": "float | None", + "description": "Spread of the whole package; the same on every leg. Present on spread-quoted packages instead of a price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Spread", + "formatterFn": "none" + } + } + }, + { + "name": "package_spread_notation", + "type": "str | None", + "description": "Format of `package_spread`: 1 (a monetary amount) or 3 (a decimal).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Spread Notation", + "hide": true + } + } + }, + { + "name": "upi_fisn", + "type": "str | None", + "description": "ISO 18774 Financial Instrument Short Name, e.g. 'NA/O Van Call EUR USD'. Its Call/Put label is unreliable; use the call and put currencies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "UPI FISN", + "hide": true + } + } + }, + { + "name": "underlier", + "type": "str | None", + "description": "UPI underlier name, the two legs of the pair as reported.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlier", + "hide": true + } + } + }, + { + "name": "unique_product_identifier", + "type": "str | None", + "description": "ISO 4914 Unique Product Identifier.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unique Product Identifier", + "hide": true + } + } + }, + { + "name": "dissemination_date", + "type": "date", + "description": "Date the SDR publicly disseminated the print, being the report date of the file it was published in.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dissemination Date", + "hide": true + } + } + }, + { + "name": "trade_key", + "type": "str | None", + "description": "Asset-class-qualified dissemination identifier, e.g. 'FX:4419821879000000101'. The qualifier keeps the 19-digit identifier out of IEEE-754 double range, which truncates it past its 16th digit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "original_trade_key", + "type": "str | None", + "description": "For an action other than 'New', the qualified identifier of the original trade being amended, corrected or terminated. Match it against a `trade_key` to follow a trade's lifecycle.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Original Trade", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "is_capped", + "type": "bool | None", + "description": "Whether any amount on the print was disseminated at a reporting cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Capped", + "hide": true + } + } + } + ] + }, + "model": "CftcFxOptionTrades", + "openapi_extra": { + "widget_config": { + "name": "FX Option Trades", + "description": "The raw FX option transactions reported to the CFTC, newest first.", + "category": "CFTC", + "subCategory": "FX", + "refetchInterval": false + }, + "model": "CftcFxOptionTrades" + } + }, + "/cftc/fx_forward_trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the raw FX forward and swap transactions disseminated by DTCC, newest first.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.cftc.fx_forward_trades(provider='cftc')\n# Get the newly executed non-deliverable forward prints.\nobb.cftc.fx_forward_trades(product_type='Non-Deliverable Forward', action_type='NEWT', provider='cftc')\n# Get the USD-settled non-deliverable forward and swap prints.\nobb.cftc.fx_forward_trades(settlement_currency='USD', provider='cftc')\n# Get the 20 largest INR forward prints of the day.\nobb.cftc.fx_forward_trades(pair='INR', min_notional=50000000, limit=20, provider='cftc')\n```\n\n", + "parameters": { + "standard": [], + "cftc": [ + { + "name": "pair", + "type": "str | None", + "description": "Filter to a pair or currency, matched against the two reported legs. 'EURUSD', 'EUR/USD' and 'EUR USD' all match EUR/USD; a single code like 'INR' matches every pair with that leg. Default is every pair, deliverable and non-deliverable.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "Filter by product: Forward (deliverable outright), Non-Deliverable Forward (cash-settled EM outright), FX Swap (near and far legs), Non-Deliverable Swap, or Non-Standard Forward. Default is every product.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None", + "description": "Dissemination date (UTC). Default is the most recent day whose file holds forward prints; a file is published every calendar day, but weekends and holidays carry almost none. Files are retained for 366 days.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate" + } + } + }, + { + "name": "action_type", + "type": "str | None", + "description": "Filter by the action reported: NEWT (new), MODI (modify), CORR (correct), TERM (terminate), EROR (error), or REVI (revive). Default is every action; pass NEWT for newly executed trades only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "settlement_currency", + "type": "str | None", + "description": "Filter to trades whose leg-1 settlement currency matches, e.g. 'USD' for the USD-settled trades regardless of pair orientation. Non-deliverable forwards and swaps always carry it - their single cash-settlement currency; deliverable trades carry it only when reported. Default is every settlement.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "min_notional", + "type": "float | None", + "description": "Drop prints whose larger notional leg is disseminated below this amount. The two legs value the same trade in each currency, so the larger is a currency-agnostic size proxy. Amounts above the reporting cap disseminate at the cap.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ticker", + "type": "str | None", + "description": "Filter to the exact UPI ticker, the Unique Product Identifier the source's TICKER report keys on. Default is every product. A ticker query is answered by the source's search API, cached per day, not the daily files.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Number of prints to return, newest execution first. Default is all matching.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the daily file locally, revalidating it against the source ETag.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CftcFxForwardTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "cftc": [ + { + "name": "event_timestamp", + "type": "datetime | None", + "description": "Date and time the reported event occurred, in UTC. The tape is ordered by it, newest first: a termination or correction of an old trade is dated when it is reported now, not when the trade was struck.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reported Time", + "sort": "desc" + } + } + }, + { + "name": "execution_timestamp", + "type": "datetime", + "description": "Date and time the forward was originally executed, in UTC. It equals the reported time on a new trade, but predates it on an amendment or termination.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Executed" + } + } + }, + { + "name": "pair", + "type": "str", + "description": "Currency pair of the forward, its two reported legs.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pair", + "cellDataType": "text", + "chartDataType": "category" + } + } + }, + { + "name": "product_type", + "type": "str | None", + "description": "Product, read from the FISN: Forward, Non-Deliverable Forward (`settlement_currency` is the cash-settled leg), FX Swap, Non-Deliverable Swap, or Non-Standard Forward. Derived, not disseminated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Type", + "cellDataType": "text" + } + } + }, + { + "name": "action_type", + "type": "str | None", + "description": "Action reported: NEWT (new), MODI (modify), CORR (correct), TERM (terminate), EROR (error), or REVI (revive). An amendment carries the original trade's identifier in `original_trade_key`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Action" + } + } + }, + { + "name": "exchange_rate", + "type": "float | None", + "description": "Agreed forward rate on the trade, oriented as `exchange_rate_basis` states. For an FX swap it is the rate of the disseminated leg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rate", + "formatterFn": "none" + } + } + }, + { + "name": "exchange_rate_basis", + "type": "str | None", + "description": "Quotation the forward rate is expressed in, e.g. 'USD/INR'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rate Basis" + } + } + }, + { + "name": "notional_1", + "type": "float | None", + "description": "Leg 1 notional, in `notional_currency_1`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional 1" + } + } + }, + { + "name": "notional_currency_1", + "type": "str | None", + "description": "Currency of the leg 1 notional.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ccy 1" + } + } + }, + { + "name": "notional_2", + "type": "float | None", + "description": "Leg 2 notional, in `notional_currency_2`.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Notional 2" + } + } + }, + { + "name": "notional_currency_2", + "type": "str | None", + "description": "Currency of the leg 2 notional.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ccy 2" + } + } + }, + { + "name": "settlement_currency", + "type": "str | None", + "description": "Settlement currency of leg 1. For a non-deliverable forward or swap it is the single currency the net cash settles in rather than delivering; a deliverable trade carries the physical settlement currency of leg 1 when reported.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Settlement Ccy" + } + } + }, + { + "name": "effective_date", + "type": "date | None", + "description": "Date the forward comes into effect.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective Date" + } + } + }, + { + "name": "expiration_date", + "type": "date | None", + "description": "Date the forward settles.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Expiry" + } + } + }, + { + "name": "days_to_expiry", + "type": "int | None", + "description": "Calendar days from execution to expiration.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Days to Expiry", + "cellDataType": "number" + } + } + }, + { + "name": "cleared", + "type": "str | None", + "description": "Whether the transaction is centrally cleared: Y (cleared), N (not cleared), or I (intent to clear).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cleared" + } + } + }, + { + "name": "venue", + "type": "str | None", + "description": "ISO 10383 segment MIC of the trading facility, or BILT when the reporting counterparty could not determine the venue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venue" + } + } + }, + { + "name": "event_type", + "type": "str | None", + "description": "Reason for the action: TRAD (trade), NOVA (novation), ETRM (early termination), or CLRG (clearing).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Event Type", + "hide": true + } + } + }, + { + "name": "block_trade", + "type": "bool | None", + "description": "Whether the print is reported as a block trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Block Trade", + "hide": true + } + } + }, + { + "name": "prime_brokerage", + "type": "bool | None", + "description": "Whether the transaction is a prime-brokerage transaction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Prime Brokerage", + "hide": true + } + } + }, + { + "name": "package_trade", + "type": "bool | None", + "description": "Whether the print is one leg of a package transaction - legs negotiated and priced together, such as the near and far legs of a swap booked as a package.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package" + } + } + }, + { + "name": "package_id", + "type": "str | None", + "description": "Grouping key shared by the legs of one package - its execution time and package price or spread. Group on it to reassemble the package. Derived, not disseminated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package ID" + } + } + }, + { + "name": "package_price", + "type": "float | None", + "description": "Price of the whole package, in the format `package_price_notation` states; the same on every leg. Present on price-quoted packages, where DTCC's 9.9999999999 not-provided placeholder has been dropped to null.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Price", + "formatterFn": "none" + } + } + }, + { + "name": "package_price_currency", + "type": "str | None", + "description": "Currency the package price is denominated in, when it is a monetary amount.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Price Ccy", + "hide": true + } + } + }, + { + "name": "package_price_notation", + "type": "str | None", + "description": "Format of `package_price`: 1 (a monetary amount, in `package_price_currency`) or 3 (a decimal).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Price Notation", + "hide": true + } + } + }, + { + "name": "package_spread", + "type": "float | None", + "description": "Spread of the whole package; the same on every leg. Present on spread-quoted packages instead of a price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Spread", + "formatterFn": "none" + } + } + }, + { + "name": "package_spread_notation", + "type": "str | None", + "description": "Format of `package_spread`: 1 (a monetary amount) or 3 (a decimal).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Package Spread Notation", + "hide": true + } + } + }, + { + "name": "upi_fisn", + "type": "str | None", + "description": "ISO 18774 Financial Instrument Short Name, e.g. 'NA/Fwd NDF INR USD'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "UPI FISN", + "hide": true + } + } + }, + { + "name": "underlier", + "type": "str | None", + "description": "UPI underlier name, the two legs of the pair as reported.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Underlier", + "hide": true + } + } + }, + { + "name": "unique_product_identifier", + "type": "str | None", + "description": "ISO 4914 Unique Product Identifier.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unique Product Identifier", + "hide": true + } + } + }, + { + "name": "dissemination_date", + "type": "date", + "description": "Date the SDR publicly disseminated the print, being the report date of the file it was published in.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dissemination Date", + "hide": true + } + } + }, + { + "name": "trade_key", + "type": "str | None", + "description": "Asset-class-qualified dissemination identifier, e.g. 'FX:4419882315000000101'. The qualifier keeps the 19-digit identifier out of IEEE-754 double range, which truncates it past its 16th digit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "original_trade_key", + "type": "str | None", + "description": "For an action other than 'New', the qualified identifier of the original trade being amended, corrected or terminated. Match it against a `trade_key` to follow a trade's lifecycle.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Original Trade", + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "is_capped", + "type": "bool | None", + "description": "Whether any amount on the print was disseminated at a reporting cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Capped", + "hide": true + } + } + } + ] + }, + "model": "CftcFxForwardTrades", + "openapi_extra": { + "widget_config": { + "name": "FX Forward Trades", + "description": "The raw FX forward and swap transactions reported to the CFTC, newest first.", + "category": "CFTC", + "subCategory": "FX", + "refetchInterval": false + }, + "model": "CftcFxForwardTrades" + } + }, + "/deribit/reference/currencies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get every currency Deribit lists, with its yield and withdrawal terms.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List every currency Deribit lists.\nobb.deribit.reference.currencies(provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitCurrencies", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str", + "description": "The abbreviation of the currency.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "currency_long", + "type": "str | None", + "description": "The full name of the currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "headerName": "Name" + } + } + }, + { + "name": "coin_type", + "type": "str | None", + "description": "The type of the currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "currency_uuid", + "type": "str | None", + "description": "The unique identifier of the currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "headerName": "Currency UUID", + "hide": true + } + } + }, + { + "name": "network_currency", + "type": "str | None", + "description": "The currency the network fee is charged in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "apr", + "type": "float | None", + "description": "The annual percentage rate earned by holding the currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series", + "headerName": "APR" + } + } + }, + { + "name": "decimals", + "type": "int | None", + "description": "The number of decimal places the currency is held to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "onchain_operations_precision", + "type": "int | None", + "description": "The number of decimal places an on-chain operation is held to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "headerName": "On-chain Precision" + } + } + }, + { + "name": "min_confirmations", + "type": "int | None", + "description": "The confirmations a deposit needs before it is credited.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_withdrawal_fee", + "type": "float | None", + "description": "The smallest fee a withdrawal is charged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "withdrawal_fee", + "type": "float | None", + "description": "The fee a withdrawal is charged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "network_fee", + "type": "float | None", + "description": "The fee the network itself charges.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "in_cross_collateral_pool", + "type": "bool | None", + "description": "Whether the currency counts towards cross collateral.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "cellDataType": "boolean" + } + } + } + ] + }, + "model": "DeribitCurrencies", + "openapi_extra": { + "widget_config": { + "name": "Deribit Currencies", + "description": "Every currency the exchange lists, with its yield and withdrawal terms.", + "category": "Crypto", + "subCategory": "Reference", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 12 + } + }, + "model": "DeribitCurrencies" + } + }, + "/deribit/reference/instruments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the full contract specification of every listed Deribit instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every instrument the exchange lists.\nobb.deribit.reference.instruments(provider='deribit')\n# Only the options settling in USDC.\nobb.deribit.reference.instruments(currency='USDC', kind='option', provider='deribit')\n# The specification of one named instrument.\nobb.deribit.reference.instruments(symbol='BTC-PERPETUAL', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more instrument names. When given, the currency and kind are ignored. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "The settlement currency of the instruments.", + "default": "any", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str | None", + "description": "The kind of instrument. Default is all of them.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expired", + "type": "bool | None", + "description": "When True, returns instruments that have already expired.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitInstruments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "instrument_id", + "type": "int | None", + "description": "The numeric identifier of the instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Instrument ID", + "cellDataType": "text", + "chartDataType": "excluded" + } + } + }, + { + "name": "kind", + "type": "str | None", + "description": "The kind of instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "instrument_type", + "type": "str | None", + "description": "Whether the instrument is linear or reversed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "future_type", + "type": "str | None", + "description": "Whether the future is linear or reversed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Whether the instrument's book is open.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "base_currency", + "type": "str | None", + "description": "The currency the instrument is based on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "quote_currency", + "type": "str | None", + "description": "The currency the instrument is quoted in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "counter_currency", + "type": "str | None", + "description": "The counter currency of the instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_currency", + "type": "str | None", + "description": "The currency the instrument settles in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_period", + "type": "str | None", + "description": "How often the instrument settles.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_type", + "type": "str | None", + "description": "The asset class of the underlying.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "product_group", + "type": "str | None", + "description": "The margin group the instrument belongs to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "price_index", + "type": "str | None", + "description": "The index the instrument is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "lot_size", + "type": "int | None", + "description": "The number of contracts in one lot.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_trade_amount", + "type": "float | None", + "description": "The smallest amount that can be traded.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "tick_size", + "type": "float | None", + "description": "The smallest price increment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_leverage", + "type": "int | None", + "description": "The highest leverage the instrument allows.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_non_default_leverage", + "type": "float | None", + "description": "The highest leverage available outside the default tier.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_liquidation_commission", + "type": "float | None", + "description": "The largest commission a liquidation is charged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "maker_commission", + "type": "float | None", + "description": "The commission charged to a resting order.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "taker_commission", + "type": "float | None", + "description": "The commission charged to an aggressing order.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "block_trade_commission", + "type": "float | None", + "description": "The commission charged to a block trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "block_trade_min_trade_amount", + "type": "float | None", + "description": "The smallest amount a block trade can be.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "block_trade_tick_size", + "type": "float | None", + "description": "The smallest price increment of a block trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "option_type", + "type": "str | None", + "description": "Whether the option is a call or a put.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "strike", + "type": "float | None", + "description": "The strike price of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "is_active", + "type": "bool | None", + "description": "Whether the instrument can be traded right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "boolean", + "chartDataType": "excluded" + } + } + }, + { + "name": "contract_size", + "type": "float | None", + "description": "The size of one contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "is_csr", + "type": "bool | None", + "description": "Whether the instrument is a cross settled routed pair.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is CSR", + "cellDataType": "boolean", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "is_cbe_routed", + "type": "bool | None", + "description": "Whether the instrument routes to Coinbase Exchange liquidity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is CBE Routed", + "cellDataType": "boolean", + "chartDataType": "excluded" + } + } + }, + { + "name": "index_id", + "type": "int | None", + "description": "The numeric identifier of the price index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "tick_size_steps", + "type": "list[dict] | None", + "description": "The price levels above which a different tick size applies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "base_currency_uuid", + "type": "str | None", + "description": "The unique identifier of the base currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Base Currency UUID", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "quote_currency_uuid", + "type": "str | None", + "description": "The unique identifier of the quote currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quote Currency UUID", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "creation_timestamp", + "type": "datetime | None", + "description": "When the instrument was listed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "expiration_timestamp", + "type": "datetime | None", + "description": "When the instrument expires. Perpetual and spot instruments carry none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitInstruments", + "openapi_extra": { + "widget_config": { + "name": "Deribit Instruments", + "description": "The full contract specification of every listed instrument.", + "category": "Crypto", + "subCategory": "Reference", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + } + }, + "model": "DeribitInstruments" + } + }, + "/deribit/reference/expirations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the expirations Deribit lists on each currency.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every expiration listed, kept apart by currency.\nobb.deribit.reference.expirations(provider='deribit')\n# The option expirations listed on BTC.\nobb.deribit.reference.expirations(currency='BTC', kind='option', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str | None", + "description": "The currency to list expirations for. 'any' pools every currency together, and 'grouped' keeps them apart.", + "default": "grouped", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str | None", + "description": "The kind of instrument.", + "default": "any", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "currency_pair", + "type": "str | None", + "description": "Narrow the listing to one currency pair, such as 'btc_usd'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitExpirations", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str", + "description": "The currency the contracts settle in.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "pinned": "left" + } + } + }, + { + "name": "kind", + "type": "str", + "description": "The kind of instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "code", + "type": "str", + "description": "The expiration as it appears in instrument names.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "expiration", + "type": "date | None", + "description": "The expiration date. Perpetual contracts carry none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitExpirations", + "openapi_extra": { + "widget_config": { + "name": "Deribit Expirations", + "description": "The expirations listed on each currency.", + "category": "Crypto", + "subCategory": "Reference", + "source": [ + "Deribit" + ], + "gridData": { + "w": 20, + "h": 12 + } + }, + "model": "DeribitExpirations" + } + }, + "/deribit/reference/combos": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the multi-leg structures Deribit lists, one row per leg.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every combo listed on BTC.\nobb.deribit.reference.combos(currency='BTC', provider='deribit')\n# The legs of one named combo.\nobb.deribit.reference.combos(combo_id='BTC-STRG-30OCT26-66000_90000', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str | None", + "description": "The currency the combos settle in.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "combo_id", + "type": "str | None | list[str | None]", + "description": "One or more combo identifiers. When given, the currency is ignored. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/combo_choices", + "style": { + "popupWidth": 600 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitCombos", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "combo_id", + "type": "str", + "description": "The identifier of the combo.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Combo ID", + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "instrument_id", + "type": "int | None", + "description": "The numeric identifier of the combo.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Instrument ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Whether the combo is still tradeable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "leg", + "type": "str", + "description": "The instrument the leg trades.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "amount", + "type": "float | None", + "description": "The size of the leg. A negative amount is a sold leg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "creation_timestamp", + "type": "datetime | None", + "description": "When the combo was listed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "state_timestamp", + "type": "datetime | None", + "description": "When the combo last changed state.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitCombos", + "openapi_extra": { + "widget_config": { + "name": "Deribit Combos", + "description": "The listed multi-leg structures, one row per leg.", + "category": "Crypto", + "subCategory": "Reference", + "source": [ + "Deribit" + ], + "gridData": { + "w": 30, + "h": 12 + } + }, + "model": "DeribitCombos" + } + }, + "/deribit/reference/announcements": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get what Deribit has announced.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The most recent exchange announcements.\nobb.deribit.reference.announcements(provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "start_date", + "type": "Any | None | str", + "description": "Return announcements published on or after this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of announcements to return.", + "default": 50, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitAnnouncements", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "datetime | str", + "description": "When the announcement was published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "title", + "type": "str", + "description": "The title of the announcement.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "body", + "type": "str", + "description": "The body of the announcement, as HTML.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "cellDataType": "text" + } + } + }, + { + "name": "important", + "type": "bool | None", + "description": "Whether the exchange flagged the announcement.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "cellDataType": "boolean" + } + } + }, + { + "name": "confirmation", + "type": "bool | None", + "description": "Whether the announcement needs acknowledging.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "cellDataType": "boolean", + "hide": true + } + } + }, + { + "name": "id", + "type": "int | None", + "description": "The identifier of the announcement.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + } + ] + }, + "model": "DeribitAnnouncements", + "openapi_extra": { + "widget_config": { + "name": "Deribit Announcements", + "description": "What the exchange has announced.", + "category": "Crypto", + "subCategory": "Reference", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 12 + } + }, + "model": "DeribitAnnouncements" + } + }, + "/deribit/reference/contract_size": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the size of one contract of an instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Read the contract size of one instrument.\nobb.deribit.reference.contract_size(symbol='BTC-PERPETUAL')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The instrument name.", + "default": "BTC-PERPETUAL", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/reference/status": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get whether the exchange has locked the platform.\n\n Returns\n -------\n dict\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Read the exchange's platform status.\n >>> obb.deribit.reference.status()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Read the exchange's platform status.\nobb.deribit.reference.status()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/reference/server_time": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the exchange's server time, in milliseconds since the epoch.\n\n Returns\n -------\n int\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Read the exchange's server time.\n >>> obb.deribit.reference.server_time()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Read the exchange's server time.\nobb.deribit.reference.server_time()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/reference/currency_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every currency the exchange lists.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get currency choices.\n >>> obb.deribit.reference.currency_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get currency choices.\nobb.deribit.reference.currency_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/reference/index_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every index the exchange publishes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the names of every published index.\nobb.deribit.reference.index_choices()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "supported", + "type": "bool", + "description": "When True, returns only the indexes instruments settle against, rather than every published index.", + "default": false, + "optional": true + }, + { + "name": "kind", + "type": "str", + "description": "Narrow the supported names to spot or derivative indexes.", + "default": "all", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/reference/instrument_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every instrument the exchange lists.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get instrument choices for one kind.\nobb.deribit.reference.instrument_choices(kind='future')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "kind", + "type": "str", + "description": "The kind of instrument. Default is all of them.", + "default": null, + "optional": true + }, + { + "name": "currency", + "type": "str", + "description": "The settlement currency of the instruments.", + "default": "any", + "optional": true + }, + { + "name": "expired", + "type": "bool", + "description": "When True, returns expired instruments.", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/reference/combo_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every combo identifier the exchange lists.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the combo identifiers listed on one currency.\nobb.deribit.reference.combo_choices(currency='BTC')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "currency", + "type": "str", + "description": "The currency the combos settle in.", + "default": "BTC", + "optional": true + }, + { + "name": "state", + "type": "str", + "description": "Narrow to active or inactive combos.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/market/book_summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top of book and session statistics of Deribit instruments.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every BTC instrument's top of book.\nobb.deribit.market.book_summary(currency='BTC', provider='deribit')\n# Only the futures.\nobb.deribit.market.book_summary(currency='BTC', kind='future', provider='deribit')\n# One named instrument.\nobb.deribit.market.book_summary(symbol='BTC-PERPETUAL', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more instrument names. When given, the currency and kind are ignored. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "The settlement currency of the instruments.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str | None", + "description": "The kind of instrument. Default is all of them.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitBookSummary", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "timestamp", + "type": "datetime | None", + "description": "When the summary was published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "base_currency", + "type": "str | None", + "description": "The currency the instrument is based on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "quote_currency", + "type": "str | None", + "description": "The currency the instrument is quoted in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "last_price", + "type": "float | None", + "description": "The price the instrument last traded at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid", + "type": "float | None", + "description": "The highest price bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask", + "type": "float | None", + "description": "The lowest price offered.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "mid", + "type": "float | None", + "description": "The midpoint of the best bid and offer.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the exchange marks positions at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "high", + "type": "float | None", + "description": "The highest price of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "low", + "type": "float | None", + "description": "The lowest price of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The price change over the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The volume of the last 24 hours, in base currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_notional", + "type": "float | None", + "description": "The volume of the last 24 hours, in quote currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_usd", + "type": "float | None", + "description": "The volume of the last 24 hours, in USD.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "headerName": "Volume USD", + "chartDataType": "excluded" + } + } + }, + { + "name": "open_interest", + "type": "float | None", + "description": "The contracts left outstanding.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "current_funding", + "type": "float | None", + "description": "The funding rate a perpetual is paying right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "funding_8h", + "type": "float | None", + "description": "The funding rate a perpetual paid over eight hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Funding 8H", + "chartDataType": "excluded" + } + } + }, + { + "name": "estimated_delivery_price", + "type": "float | None", + "description": "What the instrument would deliver at right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_rate", + "type": "float | None", + "description": "The rate the exchange prices the option's greeks at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_volatility", + "type": "float | None", + "description": "The volatility implied by the mark price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Mark IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_index", + "type": "str | None", + "description": "The future or index the option is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_price", + "type": "float | None", + "description": "The price of the underlying the option is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitBookSummary", + "openapi_extra": { + "widget_config": { + "name": "Deribit Book Summary", + "description": "The top of book and trailing session statistics of every instrument in a currency.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "params": [ + { + "paramName": "currency", + "value": "BTC" + } + ] + }, + "model": "DeribitBookSummary" + } + }, + "/deribit/market/order_book": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the resting depth of a Deribit instrument, one row per level.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The resting depth of the BTC perpetual.\nobb.deribit.market.order_book(symbol='BTC-PERPETUAL', provider='deribit')\n# A book read by its numeric instrument identifier.\nobb.deribit.market.order_book(instrument_id=210838, provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more instrument names. A perpetual can also be given by its shortened root, such as 'SOLUSDC'. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "instrument_id", + "type": "int | None", + "description": "The numeric identifier of one instrument, used in place of its name.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "depth", + "type": "int | None", + "description": "The number of levels to return on each side: 1, 5, 10, 20, 50, 100, 1000, or 10000.", + "default": 10, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "1", + "value": 1 + }, + { + "label": "5", + "value": 5 + }, + { + "label": "10", + "value": 10 + }, + { + "label": "20", + "value": 20 + }, + { + "label": "50", + "value": 50 + }, + { + "label": "100", + "value": 100 + }, + { + "label": "1000", + "value": 1000 + }, + { + "label": "10000", + "value": 10000 + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitOrderBook", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "timestamp", + "type": "datetime | None", + "description": "When the book was published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "side", + "type": "str", + "description": "Whether the level is a bid or an ask.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "level", + "type": "int", + "description": "How far the level sits from the top of the book.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "price", + "type": "float", + "description": "The price of the level.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "size", + "type": "float", + "description": "The size resting at the level.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the exchange marks positions at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The price of the index the instrument is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "change_id", + "type": "int | None", + "description": "The revision of the book the level came from.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Change ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + } + ] + }, + "model": "DeribitOrderBook", + "openapi_extra": { + "widget_config": { + "name": "Deribit Order Book", + "description": "The resting depth of one instrument, one row per level.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 20, + "h": 15 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC-PERPETUAL" + } + ], + "data": { + "table": { + "chartView": { + "enabled": false + } + } + } + }, + "model": "DeribitOrderBook" + } + }, + "/deribit/market/ticker": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the live quote, session statistics, and greeks of a Deribit instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The live quote of the BTC perpetual.\nobb.deribit.market.ticker(symbol='BTC-PERPETUAL', provider='deribit')\n# Multiple instruments are comma-separated.\nobb.deribit.market.ticker(symbol='BTC-PERPETUAL,ETH-PERPETUAL', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "One or more instrument names. A perpetual can also be given by its shortened root, such as 'SOLUSDC'. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitTicker", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "timestamp", + "type": "datetime | None", + "description": "When the quote was published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Whether the instrument's book is open.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "combo_state", + "type": "str | None", + "description": "Whether the combo is still tradeable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "last_price", + "type": "float | None", + "description": "The price the instrument last traded at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid", + "type": "float | None", + "description": "The highest price bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask", + "type": "float | None", + "description": "The lowest price offered.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_size", + "type": "float | None", + "description": "The size resting at the best bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_size", + "type": "float | None", + "description": "The size resting at the best offer.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_bid", + "type": "float | None", + "description": "The bid implied by the legs of a combo.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_ask", + "type": "float | None", + "description": "The offer implied by the legs of a combo.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the exchange marks positions at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The price of the index the instrument is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_price", + "type": "float | None", + "description": "The price the instrument last settled at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "delivery_price", + "type": "float | None", + "description": "The price an expired instrument was delivered at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "estimated_delivery_price", + "type": "float | None", + "description": "What the instrument would deliver at right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_price", + "type": "float | None", + "description": "The lowest price an order will be accepted at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_price", + "type": "float | None", + "description": "The highest price an order will be accepted at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "high", + "type": "float | None", + "description": "The highest price of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "low", + "type": "float | None", + "description": "The lowest price of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The price change over the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The volume of the last 24 hours, in base currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_notional", + "type": "float | None", + "description": "The volume of the last 24 hours, in quote currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_usd", + "type": "float | None", + "description": "The volume of the last 24 hours, in USD.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "headerName": "Volume USD", + "chartDataType": "excluded" + } + } + }, + { + "name": "open_interest", + "type": "float | None", + "description": "The contracts left outstanding.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "current_funding", + "type": "float | None", + "description": "The funding rate a perpetual is paying right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "funding_8h", + "type": "float | None", + "description": "The funding rate a perpetual paid over eight hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Funding 8H", + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_value", + "type": "float | None", + "description": "The value realized funding on a perpetual is derived from.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_rate", + "type": "float | None", + "description": "The rate the exchange prices the option's greeks at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_index", + "type": "str | None", + "description": "The future or index the option is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_price", + "type": "float | None", + "description": "The price of the underlying the option is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_volatility", + "type": "float | None", + "description": "The volatility implied by the mark price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Mark IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_iv", + "type": "float | None", + "description": "The volatility implied by the best bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Bid IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_iv", + "type": "float | None", + "description": "The volatility implied by the best offer.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Ask IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "delta", + "type": "float | None", + "description": "The sensitivity to the underlying's price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "gamma", + "type": "float | None", + "description": "The sensitivity of delta to the underlying's price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "vega", + "type": "float | None", + "description": "The sensitivity to implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "theta", + "type": "float | None", + "description": "The sensitivity to the passage of time.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "rho", + "type": "float | None", + "description": "The sensitivity to the interest rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitTicker", + "openapi_extra": { + "widget_config": { + "name": "Deribit Ticker", + "description": "The live quote, session statistics, and greeks of one instrument.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 8 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC-PERPETUAL" + } + ] + }, + "model": "DeribitTicker" + } + }, + "/deribit/market/trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Deribit prints that crossed, by instrument or across a currency.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The most recent prints on the BTC perpetual.\nobb.deribit.market.trades(symbol='BTC-PERPETUAL', provider='deribit')\n# Every BTC option print over a span.\nobb.deribit.market.trades(currency='BTC', kind='option', start_date='2026-09-01', end_date='2026-09-02', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more instrument names. When given, the currency is ignored. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "The settlement currency of the instruments.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str | None", + "description": "The kind of instrument. Only used when reading by currency, where the exchange rejects a request that leaves it out, and where spot is not offered at all. Read spot trades by symbol instead.", + "default": "future", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "Any | None | str", + "description": "Return trades from this date onwards.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "Any | None | str", + "description": "Return trades up to this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of trades to return, at most 1000.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sorting", + "type": "str | None", + "description": "The order the trades are returned in.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "timestamp", + "type": "datetime", + "description": "When the trade printed.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "direction", + "type": "str | None", + "description": "Which side the aggressor was on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Side", + "chartDataType": "excluded" + } + } + }, + { + "name": "price", + "type": "float", + "description": "The price the trade printed at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "amount", + "type": "float | None", + "description": "The size of the trade, in base currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "contracts", + "type": "float | None", + "description": "The size of the trade, in contracts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "iv", + "type": "float | None", + "description": "The volatility the option trade implies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the exchange marked the instrument at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The price of the index at the time of the trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "tick_direction", + "type": "int | None", + "description": "How the price moved against the previous trade. 0 and 1 are upticks, 2 and 3 are downticks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "trade_id", + "type": "str | None", + "description": "The identifier of the trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "trade_seq", + "type": "int | None", + "description": "The sequence number of the trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trade Seq", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "block_trade_id", + "type": "str | None", + "description": "The block trade the print belongs to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Block Trade ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "liquidation", + "type": "str | None", + "description": "Which side of the trade was liquidated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "starbase_match_id", + "type": "int | None", + "description": "The matching engine's identifier for the fill.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Match ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "starbase_timestamp", + "type": "int | None", + "description": "When the matching engine recorded the fill, in nanoseconds since the epoch.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Match Timestamp", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + } + ] + }, + "model": "DeribitTrades", + "openapi_extra": { + "widget_config": { + "name": "Deribit Trades", + "description": "The prints that crossed, by instrument or across a currency.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC-PERPETUAL" + } + ], + "data": { + "table": { + "chartView": { + "enabled": false + } + } + } + }, + "model": "DeribitTrades" + } + }, + "/deribit/market/trade_volumes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Deribit's traded volume by currency and product.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Traded volume by currency and product.\nobb.deribit.market.trade_volumes(provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "extended", + "type": "bool | None", + "description": "When True, adds the seven and thirty day volumes to the trailing twenty-four hours.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitTradeVolumes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str", + "description": "The currency the volume was traded in.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "currency_pair", + "type": "str | None", + "description": "The index the currency is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "futures_volume", + "type": "float | None", + "description": "The futures volume of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Futures Volume", + "chartDataType": "series" + } + } + }, + { + "name": "calls_volume", + "type": "float | None", + "description": "The call volume of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Calls Volume", + "chartDataType": "excluded" + } + } + }, + { + "name": "puts_volume", + "type": "float | None", + "description": "The put volume of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Puts Volume", + "chartDataType": "excluded" + } + } + }, + { + "name": "spot_volume", + "type": "float | None", + "description": "The spot volume of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spot Volume", + "chartDataType": "excluded" + } + } + }, + { + "name": "futures_volume_7d", + "type": "float | None", + "description": "The futures volume of the last seven days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Futures Volume 7D", + "chartDataType": "excluded" + } + } + }, + { + "name": "calls_volume_7d", + "type": "float | None", + "description": "The call volume of the last seven days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Calls Volume 7D", + "chartDataType": "excluded" + } + } + }, + { + "name": "puts_volume_7d", + "type": "float | None", + "description": "The put volume of the last seven days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Puts Volume 7D", + "chartDataType": "excluded" + } + } + }, + { + "name": "spot_volume_7d", + "type": "float | None", + "description": "The spot volume of the last seven days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spot Volume 7D", + "chartDataType": "excluded" + } + } + }, + { + "name": "futures_volume_30d", + "type": "float | None", + "description": "The futures volume of the last thirty days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Futures Volume 30D", + "chartDataType": "excluded" + } + } + }, + { + "name": "calls_volume_30d", + "type": "float | None", + "description": "The call volume of the last thirty days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Calls Volume 30D", + "chartDataType": "excluded" + } + } + }, + { + "name": "puts_volume_30d", + "type": "float | None", + "description": "The put volume of the last thirty days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Puts Volume 30D", + "chartDataType": "excluded" + } + } + }, + { + "name": "spot_volume_30d", + "type": "float | None", + "description": "The spot volume of the last thirty days.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spot Volume 30D", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitTradeVolumes", + "openapi_extra": { + "widget_config": { + "name": "Deribit Trade Volumes", + "description": "Traded volume by currency and product, over one, seven, and thirty days.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 12 + } + }, + "model": "DeribitTradeVolumes" + } + }, + "/deribit/market/block_rfq_trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Deribit block requests that traded, one row per leg.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The block requests that most recently traded.\nobb.deribit.market.block_rfq_trades(provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str | None", + "description": "The settlement currency of the quoted legs.", + "default": "any", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of requests to return, between 10 and 50.", + "default": 50, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitBlockRfqTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "timestamp", + "type": "datetime", + "description": "When the request traded.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "rfq_id", + "type": "int | None", + "description": "The identifier of the request.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RFQ ID", + "cellDataType": "text", + "chartDataType": "excluded" + } + } + }, + { + "name": "combo_id", + "type": "str | None", + "description": "The combo the request was quoted as.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Combo ID", + "chartDataType": "excluded" + } + } + }, + { + "name": "direction", + "type": "str | None", + "description": "Which side the taker was on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Side", + "chartDataType": "excluded" + } + } + }, + { + "name": "amount", + "type": "float | None", + "description": "The size of the request.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the exchange marked the structure at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "leg", + "type": "str | None", + "description": "The instrument the leg trades.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "leg_direction", + "type": "str | None", + "description": "Which side the leg was traded on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "leg_price", + "type": "float | None", + "description": "The price the leg traded at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "leg_ratio", + "type": "float | None", + "description": "How many of the leg one structure holds.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "index_prices", + "type": "dict | None", + "description": "The index prices the structure was marked against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + } + ] + }, + "model": "DeribitBlockRfqTrades", + "openapi_extra": { + "widget_config": { + "name": "Deribit Block RFQ Trades", + "description": "The block requests that traded, one row per leg.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + } + }, + "model": "DeribitBlockRfqTrades" + } + }, + "/deribit/market/settlements": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the settlements, deliveries, and bankruptcies Deribit has processed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The most recent BTC settlements.\nobb.deribit.market.settlements(currency='BTC', provider='deribit')\n# Only the deliveries of one instrument.\nobb.deribit.market.settlements(symbol='BTC-PERPETUAL', settlement_type='settlement', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more instrument names. When given, the currency is ignored. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "The settlement currency of the instruments.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "settlement_type", + "type": "str | None", + "description": "The kind of settlement. Default is all of them.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "Any | None | str", + "description": "Search back no further than this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of settlements to return, at most 1000.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitSettlements", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "timestamp", + "type": "datetime", + "description": "When the instrument settled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "symbol", + "type": "str | None", + "description": "The name of the instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_type", + "type": "str | None", + "description": "Whether the event was a settlement or a delivery.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Type", + "chartDataType": "excluded" + } + } + }, + { + "name": "position", + "type": "float | None", + "description": "The size that settled.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The level of the index at settlement.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the instrument settled at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "profit_loss", + "type": "float | None", + "description": "The profit and loss the settlement realized.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Profit & Loss", + "chartDataType": "excluded", + "renderFn": "greenRed" + } + } + }, + { + "name": "session_profit_loss", + "type": "float | None", + "description": "The profit and loss of the whole session.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Session Profit & Loss", + "chartDataType": "excluded", + "renderFn": "greenRed" + } + } + }, + { + "name": "funding", + "type": "float | None", + "description": "The funding the session paid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "session_bankruptcy", + "type": "float | None", + "description": "The loss the session could not cover.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "session_tax", + "type": "float | None", + "description": "The socialised loss the session was charged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "session_tax_rate", + "type": "float | None", + "description": "The rate the socialised loss was charged at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "socialized", + "type": "float | None", + "description": "The loss spread across other accounts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitSettlements", + "openapi_extra": { + "widget_config": { + "name": "Deribit Settlements", + "description": "The settlements, deliveries, and bankruptcies the exchange has processed.", + "category": "Crypto", + "subCategory": "Market Data", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "params": [ + { + "paramName": "currency", + "value": "BTC" + } + ] + }, + "model": "DeribitSettlements" + } + }, + "/deribit/index/price": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the current level of a Deribit index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The current level of the BTC index.\nobb.deribit.index.price(index_name='btc_usd', provider='deribit')\n# Multiple indexes are comma-separated.\nobb.deribit.index.price(index_name='btc_usd,eth_usd', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "index_name", + "type": "str | None | list[str | None]", + "description": "One or more index names, such as 'btc_usd'. Multiple items allowed.", + "default": "btc_usd", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/index_choices", + "style": { + "popupWidth": 600 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitIndexPrice", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "index_name", + "type": "str", + "description": "The name of the index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The current level of the index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "estimated_delivery_price", + "type": "float | None", + "description": "What instruments on the index would deliver at right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitIndexPrice", + "openapi_extra": { + "widget_config": { + "name": "Deribit Index Price", + "description": "The current level of an index, and what it would deliver at.", + "category": "Crypto", + "subCategory": "Index", + "source": [ + "Deribit" + ], + "gridData": { + "w": 20, + "h": 6 + }, + "params": [ + { + "paramName": "index_name", + "value": "btc_usd" + } + ] + }, + "model": "DeribitIndexPrice" + } + }, + "/deribit/index/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the published level of a Deribit index over a span.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The BTC index over the last day.\nobb.deribit.index.historical(index_name='btc_usd', provider='deribit')\n# The whole published history.\nobb.deribit.index.historical(index_name='btc_usd', span='all', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "index_name", + "type": "str | None | list[str | None]", + "description": "One or more index names, such as 'btc_usd'. Multiple items allowed.", + "default": "btc_usd", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/index_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "span", + "type": "str | None", + "description": "How far back the series runs.", + "default": "1d", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitIndexHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "datetime | str", + "description": "When the level was published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "index_name", + "type": "str", + "description": "The name of the index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "price", + "type": "float", + "description": "The level of the index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "DeribitIndexHistorical", + "openapi_extra": { + "widget_config": { + "name": "Deribit Index History", + "description": "The published level of an index over a span.", + "category": "Crypto", + "subCategory": "Index", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "index_name", + "value": "btc_usd" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitIndexHistorical" + } + }, + "/deribit/index/delivery_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the level a Deribit index has delivered at.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The level the BTC index has delivered at.\nobb.deribit.index.delivery_prices(index_name='btc_usd', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "index_name", + "type": "str | None | list[str | None]", + "description": "One or more index names, such as 'btc_usd'. Multiple items allowed.", + "default": "btc_usd", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/index_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of settlements to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "How many of the most recent settlements to skip.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitDeliveryPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "date | str", + "description": "The session the index delivered on.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "index_name", + "type": "str", + "description": "The name of the index.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "delivery_price", + "type": "float", + "description": "The level the index delivered at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "DeribitDeliveryPrices", + "openapi_extra": { + "widget_config": { + "name": "Deribit Delivery Prices", + "description": "The level each index has delivered at.", + "category": "Crypto", + "subCategory": "Index", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "index_name", + "value": "btc_usd" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitDeliveryPrices" + } + }, + "/deribit/rates/funding_history": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the hourly funding a Deribit perpetual has paid.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The funding the BTC perpetual has paid over the last week.\nobb.deribit.rates.funding_history(symbol='BTC-PERPETUAL', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more perpetual instrument names. A perpetual can also be given by its shortened root, such as 'SOLUSDC'. Multiple items allowed.", + "default": "BTC-PERPETUAL", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/futures/perpetual_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "start_date", + "type": "Any | None | str", + "description": "Return rates from this date onwards.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "Any | None | str", + "description": "Return rates up to this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitFundingRateHistory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "datetime | str", + "description": "The hour the rate applied to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_1h", + "type": "float | None", + "description": "The funding rate over the hour.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Interest 1H", + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_8h", + "type": "float | None", + "description": "The funding rate over the trailing eight hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Interest 8H", + "chartDataType": "series" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The level of the index at the end of the hour.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "prev_index_price", + "type": "float | None", + "description": "The level of the index at the start of the hour.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "headerName": "Previous Index Price", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitFundingRateHistory", + "openapi_extra": { + "widget_config": { + "name": "Deribit Funding Rate History", + "description": "The hourly funding a perpetual has paid.", + "category": "Crypto", + "subCategory": "Rates", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC-PERPETUAL" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitFundingRateHistory" + } + }, + "/deribit/rates/funding_chart": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the funding a Deribit perpetual has accrued over the current window.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The funding the BTC perpetual has accrued over eight hours.\nobb.deribit.rates.funding_chart(symbol='BTC-PERPETUAL', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "One or more perpetual instrument names. A perpetual can also be given by its shortened root, such as 'SOLUSDC'. Multiple items allowed.", + "default": "BTC-PERPETUAL", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/futures/perpetual_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "length", + "type": "str | None", + "description": "How far back the series runs.", + "default": "8h", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitFundingChart", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "datetime | str", + "description": "When the rate was published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_8h", + "type": "float | None", + "description": "The funding rate over the trailing eight hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Interest 8H", + "chartDataType": "series" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The level of the index when the rate was published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "current_interest", + "type": "float | None", + "description": "The funding rate accrued so far in the current interval.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitFundingChart", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "DeribitFundingChart" + } + }, + "/deribit/rates/apr_history": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the daily yield a Deribit yield-bearing currency has earned.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The yield USDe has earned.\nobb.deribit.rates.apr_history(currency='usde', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str | None", + "description": "The yield-bearing currency.", + "default": "usde", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of days to return.", + "default": 365, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitAprHistory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "date | str", + "description": "The day the rate applied to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "currency", + "type": "str", + "description": "The currency earning the rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "apr", + "type": "float", + "description": "The annual percentage rate the currency earned.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "APR", + "chartDataType": "series" + } + } + } + ] + }, + "model": "DeribitAprHistory", + "openapi_extra": { + "widget_config": { + "name": "Deribit Yield History", + "description": "The daily yield a yield-bearing currency has earned.", + "category": "Crypto", + "subCategory": "Rates", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitAprHistory" + } + }, + "/deribit/rates/funding_value": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the funding one perpetual paid over a span, as a single rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Read the funding one perpetual paid over a span.\nobb.deribit.rates.funding_value(symbol='BTC-PERPETUAL', start_date='2026-09-01', end_date='2026-09-08')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The perpetual instrument name.", + "default": "BTC-PERPETUAL", + "optional": true + }, + { + "name": "start_date", + "type": "str", + "description": "The first date of the span.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "str", + "description": "The last date of the span.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/volatility/realized": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the volatility a Deribit currency has actually realized.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The volatility BTC has realized.\nobb.deribit.volatility.realized(currency='BTC', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str | None | list[str | None]", + "description": "The currency whose realized volatility to read. Multiple items allowed.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "BTC", + "value": "BTC" + }, + { + "label": "ETH", + "value": "ETH" + }, + { + "label": "EURR", + "value": "EURR" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitHistoricalVolatility", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "datetime | str", + "description": "When the reading was published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "currency", + "type": "str", + "description": "The currency the reading belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volatility", + "type": "float", + "description": "The realized volatility over the trailing window.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "DeribitHistoricalVolatility", + "openapi_extra": { + "widget_config": { + "name": "Deribit Realized Volatility", + "description": "The volatility a currency has actually realized.", + "category": "Crypto", + "subCategory": "Volatility", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "currency", + "value": "BTC" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitHistoricalVolatility" + } + }, + "/deribit/volatility/index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Deribit DVOL volatility index, as candles over a span.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The BTC volatility index over the last month.\nobb.deribit.volatility.index(currency='BTC', provider='deribit')\n# Daily candles over a named span.\nobb.deribit.volatility.index(currency='ETH', interval='1d', start_date='2026-01-01', end_date='2026-06-30', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "currency", + "type": "str | None | list[str | None]", + "description": "The currency whose volatility index to read. Multiple items allowed.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "BTC", + "value": "BTC" + }, + { + "label": "ETH", + "value": "ETH" + } + ] + } + } + }, + { + "name": "start_date", + "type": "Any | None | str", + "description": "Return candles from this date onwards.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "Any | None | str", + "description": "Return candles up to this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitVolatilityIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "date", + "type": "datetime | str", + "description": "When the candle closed.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "currency", + "type": "str", + "description": "The currency the index belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "open", + "type": "float", + "description": "The level the candle opened at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "high", + "type": "float", + "description": "The highest level of the candle.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "low", + "type": "float", + "description": "The lowest level of the candle.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "close", + "type": "float", + "description": "The level the candle closed at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "DeribitVolatilityIndex", + "openapi_extra": { + "widget_config": { + "name": "Deribit Volatility Index", + "description": "The DVOL index, as candles over a span.", + "category": "Crypto", + "subCategory": "Volatility", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 14 + }, + "params": [ + { + "paramName": "currency", + "value": "BTC" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitVolatilityIndex" + } + }, + "/deribit/futures/curve_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every underlying with a listed futures curve.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the underlyings with a listed futures curve.\n >>> obb.deribit.futures.curve_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the underlyings with a listed futures curve.\nobb.deribit.futures.curve_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/futures/perpetual_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every perpetual the exchange lists.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the listed perpetuals.\n >>> obb.deribit.futures.perpetual_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the listed perpetuals.\nobb.deribit.futures.perpetual_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/futures/instruments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the contract specification of every listed Deribit future.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every future Deribit lists.\nobb.deribit.futures.instruments(provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitFuturesInstruments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "instrument_id", + "type": "int", + "description": "The numeric identifier of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Instrument ID", + "cellDataType": "text", + "chartDataType": "excluded" + } + } + }, + { + "name": "kind", + "type": "str | None", + "description": "The kind of instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "instrument_type", + "type": "str | None", + "description": "Whether the instrument is linear or reversed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "future_type", + "type": "str | None", + "description": "Whether the future is linear or reversed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Whether the instrument's book is open.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "base_currency", + "type": "str | None", + "description": "The currency the instrument is based on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "quote_currency", + "type": "str | None", + "description": "The currency the instrument is quoted in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "counter_currency", + "type": "str | None", + "description": "The counter currency of the instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_currency", + "type": "str | None", + "description": "The currency the instrument settles in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_period", + "type": "str | None", + "description": "How often the instrument settles.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_type", + "type": "str | None", + "description": "The asset class of the underlying.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "product_group", + "type": "str | None", + "description": "The margin group the instrument belongs to.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "price_index", + "type": "str | None", + "description": "The index the instrument is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "lot_size", + "type": "int | None", + "description": "The number of contracts in one lot.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_trade_amount", + "type": "float | None", + "description": "The smallest amount that can be traded.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "tick_size", + "type": "float | None", + "description": "The smallest price increment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_leverage", + "type": "int | None", + "description": "The highest leverage the instrument allows.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_non_default_leverage", + "type": "float | None", + "description": "The highest leverage available outside the default tier.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_liquidation_commission", + "type": "float | None", + "description": "The largest commission a liquidation is charged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "maker_commission", + "type": "float | None", + "description": "The commission charged to a resting order.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "taker_commission", + "type": "float | None", + "description": "The commission charged to an aggressing order.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "block_trade_commission", + "type": "float | None", + "description": "The commission charged to a block trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "block_trade_min_trade_amount", + "type": "float | None", + "description": "The smallest amount a block trade can be.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "block_trade_tick_size", + "type": "float | None", + "description": "The smallest price increment of a block trade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "is_active", + "type": "bool | None", + "description": "Whether the instrument can be traded right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "boolean", + "chartDataType": "excluded" + } + } + }, + { + "name": "contract_size", + "type": "float | None", + "description": "The size of one contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "index_id", + "type": "int | None", + "description": "The numeric identifier of the price index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Index ID", + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "tick_size_steps", + "type": "list[dict] | None", + "description": "The price levels above which a different tick size applies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "cellDataType": "text", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "base_currency_uuid", + "type": "str | None", + "description": "The unique identifier of the base currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Base Currency UUID", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "quote_currency_uuid", + "type": "str | None", + "description": "The unique identifier of the quote currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Quote Currency UUID", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "creation_timestamp", + "type": "datetime | None", + "description": "When the instrument was listed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "expiration_timestamp", + "type": "datetime | None", + "description": "When the instrument expires. Perpetual contracts carry none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitFuturesInstruments", + "openapi_extra": { + "widget_config": { + "name": "Deribit Futures Instruments", + "description": "The contract specification of every listed future.", + "category": "Crypto", + "subCategory": "Futures", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + } + }, + "model": "DeribitFuturesInstruments" + } + }, + "/deribit/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the term structure of a Deribit underlying's dated futures.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The current BTC futures term structure.\nobb.deribit.futures.curve(symbol='BTC', provider='deribit')\n# The curve against where it stood a day ago.\nobb.deribit.futures.curve(symbol='BTC', hours_ago=24, provider='deribit')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "deribit": { + "multiple_items_allowed": false, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/futures/curve_choices", + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "date", + "type": "date | str | None | str", + "description": "A specific date to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "deribit": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for. The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "hours_ago", + "type": "str | None | list[str | None]", + "description": "Compare the current curve against how it stood this many hours ago. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitFuturesCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the futures contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + } + ], + "deribit": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category", + "pinned": "left" + } + } + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the futures contract, taken from the mark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "symbol", + "type": "str | None", + "description": "The name of the contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "last_price", + "type": "float | None", + "description": "The price the contract last traded at, which on a thin contract can be a long way from the mark the curve is built on.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "hours_ago", + "type": "int | None", + "description": "How many hours back the price was read, when the query asked for one.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitFuturesCurve", + "openapi_extra": { + "widget_config": { + "name": "Deribit Futures Curve", + "description": "The term structure of an underlying's dated futures, optionally against how it stood some hours ago.", + "category": "Crypto", + "subCategory": "Futures", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitFuturesCurve" + } + }, + "/deribit/futures/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get candles for any listed Deribit instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily candles for the BTC perpetual.\nobb.deribit.futures.historical(symbol='BTC-PERPETUAL', provider='deribit')\n# Hourly candles over a named span.\nobb.deribit.futures.historical(symbol='BTC-PERPETUAL', interval='1h', start_date='2026-09-01', end_date='2026-09-15', provider='deribit')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): deribit.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "deribit": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str | None", + "description": "Future expiry date with format YYYY-MM", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "deribit": { + "x-widget_config": { + "exclude": true + } + } + } + } + ], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. Any listed instrument works, not only futures. A perpetual can also be given by its shortened root, such as 'SOLUSDC'.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "3m", + "5m", + "10m", + "15m", + "30m", + "1h", + "2h", + "3h", + "6h", + "12h", + "1d" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitFuturesHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "deribit": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "symbol", + "type": "str | None", + "description": "The name of the instrument.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_notional", + "type": "float | None", + "description": "The volume of the candle, in quote currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitFuturesHistorical", + "openapi_extra": { + "widget_config": { + "name": "Deribit Historical Prices", + "description": "Candles for any listed instrument, not only futures.", + "category": "Crypto", + "subCategory": "Futures", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC-PERPETUAL" + } + ], + "data": { + "table": { + "chartView": { + "enabled": true, + "chartType": "line" + } + } + } + }, + "model": "DeribitFuturesHistorical" + } + }, + "/deribit/futures/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the live quote and session statistics of a Deribit future.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The live quote of the BTC perpetual.\nobb.deribit.futures.info(symbol='BTC-PERPETUAL', provider='deribit')\n```\n\n", + "parameters": { + "standard": [], + "deribit": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. A perpetual can be given by its currency pair - SOLUSDC - or by its full instrument name - SOL_USDC-PERPETUAL. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/reference/instrument_choices", + "style": { + "popupWidth": 600 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitFuturesInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "deribit": [ + { + "name": "symbol", + "type": "str", + "description": "The name of the instrument.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "timestamp", + "type": "datetime | None", + "description": "When the quote was published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Whether the instrument's book is open.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "combo_state", + "type": "str | None", + "description": "Whether the combo is still tradeable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "last_price", + "type": "float | None", + "description": "The price the instrument last traded at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid", + "type": "float | None", + "description": "The highest price bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask", + "type": "float | None", + "description": "The lowest price offered.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_size", + "type": "float | None", + "description": "The size resting at the best bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_size", + "type": "float | None", + "description": "The size resting at the best offer.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_bid", + "type": "float | None", + "description": "The bid implied by the legs of a combo.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_ask", + "type": "float | None", + "description": "The offer implied by the legs of a combo.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "mark_price", + "type": "float | None", + "description": "The price the exchange marks positions at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "index_price", + "type": "float | None", + "description": "The price of the index the instrument is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_price", + "type": "float | None", + "description": "The price the instrument last settled at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "delivery_price", + "type": "float | None", + "description": "The price an expired instrument was delivered at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "estimated_delivery_price", + "type": "float | None", + "description": "What the instrument would deliver at right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_price", + "type": "float | None", + "description": "The lowest price an order will be accepted at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_price", + "type": "float | None", + "description": "The highest price an order will be accepted at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "high", + "type": "float | None", + "description": "The highest price of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "low", + "type": "float | None", + "description": "The lowest price of the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The price change over the last 24 hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The volume of the last 24 hours, in base currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_notional", + "type": "float | None", + "description": "The volume of the last 24 hours, in quote currency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_usd", + "type": "float | None", + "description": "The volume of the last 24 hours, in USD.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "headerName": "Volume USD", + "chartDataType": "excluded" + } + } + }, + { + "name": "open_interest", + "type": "float | None", + "description": "The contracts left outstanding.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "current_funding", + "type": "float | None", + "description": "The funding rate a perpetual is paying right now.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "funding_8h", + "type": "float | None", + "description": "The funding rate a perpetual paid over eight hours.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Funding 8H", + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_value", + "type": "float | None", + "description": "The value realized funding on a perpetual is derived from.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_rate", + "type": "float | None", + "description": "The rate the exchange prices the option's greeks at.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_index", + "type": "str | None", + "description": "The future or index the option is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_price", + "type": "float | None", + "description": "The price of the underlying the option is priced against.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_volatility", + "type": "float | None", + "description": "The volatility implied by the mark price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Mark IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_iv", + "type": "float | None", + "description": "The volatility implied by the best bid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Bid IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_iv", + "type": "float | None", + "description": "The volatility implied by the best offer.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Ask IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "delta", + "type": "float | None", + "description": "The sensitivity to the underlying's price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "gamma", + "type": "float | None", + "description": "The sensitivity of delta to the underlying's price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "vega", + "type": "float | None", + "description": "The sensitivity to implied volatility.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "theta", + "type": "float | None", + "description": "The sensitivity to the passage of time.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "rho", + "type": "float | None", + "description": "The sensitivity to the interest rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitFuturesInfo", + "openapi_extra": { + "widget_config": { + "name": "Deribit Futures Info", + "description": "The live quote and session statistics of a perpetual or dated future.", + "category": "Crypto", + "subCategory": "Futures", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 8 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC-PERPETUAL" + } + ] + }, + "model": "DeribitFuturesInfo" + } + }, + "/deribit/options/underlying_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every underlying with listed options.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the underlyings with listed options.\n >>> obb.deribit.options.underlying_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the underlyings with listed options.\nobb.deribit.options.underlying_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/options/expiration_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every expiration the underlying lists.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the expirations listed on an underlying.\nobb.deribit.options.expiration_choices(symbol='BTC')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/options/strike_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every strike the underlying lists.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the strikes listed on an underlying.\nobb.deribit.options.strike_choices(symbol='BTC')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/options/chains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the full Deribit option chain of an underlying, with greeks.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The full BTC option chain.\nobb.deribit.options.chains(symbol='BTC', provider='deribit')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "deribit": { + "multiple_items_allowed": false, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/deribit/options/underlying_choices", + "style": { + "popupWidth": 600 + } + } + } + } + } + ], + "deribit": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DeribitOptionsChains", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "underlying_symbol", + "type": "list[str] | None", + "description": "Underlying symbol for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_price", + "type": "list[float] | None", + "description": "Price of the underlying stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "contract_symbol", + "type": "list[str]", + "description": "Contract symbol for the option.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eod_date", + "type": "list[date] | None", + "description": "Date for which the options chains are returned.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "list[date]", + "description": "Expiration date of the contract.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dte", + "type": "list[int] | None", + "description": "Days to expiration of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strike", + "type": "list[float]", + "description": "Strike price of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "option_type", + "type": "list[str]", + "description": "Call or Put.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "contract_size", + "type": "list[Union[int, float]] | None", + "description": "Number of underlying units per contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "list[Union[int, float]] | None", + "description": "Open interest on the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "list[Union[int, float]] | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "theoretical_price", + "type": "list[float] | None", + "description": "Theoretical value of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_price", + "type": "list[float] | None", + "description": "Last trade price of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_size", + "type": "list[Union[int, float]] | None", + "description": "Last trade size of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "list[datetime] | None", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick", + "type": "list[str] | None", + "description": "Whether the last tick was up or down in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "list[float] | None", + "description": "Current bid price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_size", + "type": "list[Union[int, float]] | None", + "description": "Bid size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_time", + "type": "list[datetime] | None", + "description": "The timestamp of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "list[str] | None", + "description": "The exchange of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "list[float] | None", + "description": "Current ask price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_size", + "type": "list[Union[int, float]] | None", + "description": "Ask size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_time", + "type": "list[datetime] | None", + "description": "The timestamp of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "list[str] | None", + "description": "The exchange of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mark", + "type": "list[float] | None", + "description": "The mid-price between the latest bid and ask.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open", + "type": "list[float] | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_bid", + "type": "list[float] | None", + "description": "The opening bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_ask", + "type": "list[float] | None", + "description": "The opening ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "high", + "type": "list[float] | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_high", + "type": "list[float] | None", + "description": "The highest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_high", + "type": "list[float] | None", + "description": "The highest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "low", + "type": "list[float] | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_low", + "type": "list[float] | None", + "description": "The lowest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_low", + "type": "list[float] | None", + "description": "The lowest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close", + "type": "list[float] | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_size", + "type": "list[Union[int, float]] | None", + "description": "The closing trade size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_time", + "type": "list[datetime] | None", + "description": "The time of the closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid", + "type": "list[float] | None", + "description": "The closing bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_bid_size", + "type": "list[Union[int, float]] | None", + "description": "The closing bid size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid_time", + "type": "list[datetime] | None", + "description": "The time of the bid closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask", + "type": "list[float] | None", + "description": "The closing ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_size", + "type": "list[Union[int, float]] | None", + "description": "The closing ask size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_time", + "type": "list[datetime] | None", + "description": "The time of the ask closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "list[float] | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "list[float] | None", + "description": "The change in the price of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "list[float] | None", + "description": "Change, in normalized percentage points, of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "implied_volatility", + "type": "list[float] | None", + "description": "Implied volatility of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "delta", + "type": "list[float] | None", + "description": "Delta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "gamma", + "type": "list[float] | None", + "description": "Gamma of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "theta", + "type": "list[float] | None", + "description": "Theta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "vega", + "type": "list[float] | None", + "description": "Vega of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "rho", + "type": "list[float] | None", + "description": "Rho of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + } + ], + "deribit": [ + { + "name": "underlying_symbol", + "type": "list[str]", + "description": "The future or index the contract is priced against.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_price", + "type": "list[float]", + "description": "The price of the underlying the contract is priced against.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "contract_symbol", + "type": "list[str]", + "description": "The symbol of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Contract", + "chartDataType": "excluded", + "pinned": "left" + } + } + }, + { + "name": "eod_date", + "type": "list[date] | None", + "description": "The end-of-day date. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "EOD Date", + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "expiration", + "type": "list[date]", + "description": "The expiration date of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "dte", + "type": "list[int]", + "description": "The number of days until expiration.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "DTE", + "chartDataType": "excluded" + } + } + }, + { + "name": "strike", + "type": "list[float]", + "description": "The strike price of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "option_type", + "type": "list[str]", + "description": "Whether the contract is a call or a put.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Type", + "chartDataType": "excluded" + } + } + }, + { + "name": "contract_size", + "type": "list[Union[int, float]]", + "description": "The size of one contract, in units of the underlying.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "open_interest", + "type": "list[Union[int, float]]", + "description": "The contracts left outstanding.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume", + "type": "list[Union[int, float]]", + "description": "The volume of the session.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "theoretical_price", + "type": "list[float] | None", + "description": "The theoretical price of the contract. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "last_trade_price", + "type": "list[float]", + "description": "The price the contract last traded at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "last_trade_size", + "type": "list[Union[int, float]] | None", + "description": "The size of the last trade. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "last_trade_time", + "type": "list[datetime] | None", + "description": "When the last trade printed. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "tick", + "type": "list[str] | None", + "description": "The direction of the last price move. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "bid", + "type": "list[float]", + "description": "The highest price bid.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_size", + "type": "list[Union[int, float]]", + "description": "The size resting at the best bid.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_time", + "type": "list[datetime] | None", + "description": "When the bid was published. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "bid_exchange", + "type": "list[str] | None", + "description": "The exchange the bid came from. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "ask", + "type": "list[float]", + "description": "The lowest price offered.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_size", + "type": "list[Union[int, float]]", + "description": "The size resting at the best offer.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_time", + "type": "list[datetime] | None", + "description": "When the offer was published. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "ask_exchange", + "type": "list[str] | None", + "description": "The exchange the offer came from. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "mark", + "type": "list[float]", + "description": "The mark price of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "open", + "type": "list[float] | None", + "description": "The opening price of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "open_bid", + "type": "list[float] | None", + "description": "The opening bid of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "open_ask", + "type": "list[float] | None", + "description": "The opening offer of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "high", + "type": "list[float]", + "description": "The highest price of the session.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_high", + "type": "list[float] | None", + "description": "The highest bid of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "ask_high", + "type": "list[float] | None", + "description": "The highest offer of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "low", + "type": "list[float]", + "description": "The lowest price of the session.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_low", + "type": "list[float] | None", + "description": "The lowest bid of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "ask_low", + "type": "list[float] | None", + "description": "The lowest offer of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close", + "type": "list[float] | None", + "description": "The closing price of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_size", + "type": "list[Union[int, float]] | None", + "description": "The size of the closing trade. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_time", + "type": "list[datetime] | None", + "description": "When the closing trade printed. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_bid", + "type": "list[float] | None", + "description": "The closing bid of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_bid_size", + "type": "list[Union[int, float]] | None", + "description": "The size at the closing bid. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_bid_time", + "type": "list[datetime] | None", + "description": "When the closing bid was published. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_ask", + "type": "list[float] | None", + "description": "The closing offer of the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_ask_size", + "type": "list[Union[int, float]] | None", + "description": "The size at the closing offer. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "close_ask_time", + "type": "list[datetime] | None", + "description": "When the closing offer was published. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "prev_close", + "type": "list[float] | None", + "description": "The closing price of the previous session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "change", + "type": "list[float] | None", + "description": "The price change over the session. Deribit publishes none.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded", + "hide": true + } + } + }, + { + "name": "change_percent", + "type": "list[float]", + "description": "The price change over the session.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "implied_volatility", + "type": "list[float]", + "description": "The volatility implied by the mark price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Mark IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "delta", + "type": "list[float]", + "description": "The sensitivity to the underlying's price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "gamma", + "type": "list[float]", + "description": "The sensitivity of delta to the underlying's price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "theta", + "type": "list[float]", + "description": "The sensitivity to the passage of time.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "vega", + "type": "list[float]", + "description": "The sensitivity to implied volatility.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "rho", + "type": "list[float]", + "description": "The sensitivity to the interest rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "volume_notional", + "type": "list[float]", + "description": "The notional volume of the contract, in USD or USDC.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "bid_iv", + "type": "list[float]", + "description": "The volatility implied by the bid price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Bid IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "ask_iv", + "type": "list[float]", + "description": "The volatility implied by the ask price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "headerName": "Ask IV", + "chartDataType": "excluded" + } + } + }, + { + "name": "interest_rate", + "type": "list[float]", + "description": "The rate the exchange prices the greeks at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "settlement_price", + "type": "list[float]", + "description": "The price the contract last settled at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "min_price", + "type": "list[float]", + "description": "The lowest price an order will be accepted at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "max_price", + "type": "list[float]", + "description": "The highest price an order will be accepted at.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "underlying_spot_price", + "type": "list[float]", + "description": "The spot price of the underlying the option is based on.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "is_inverse", + "type": "list[bool] | None", + "description": "Whether the contract settles in the underlying rather than in the quote currency, which changes how its payoff is valued.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Is Inverse", + "cellDataType": "boolean", + "chartDataType": "excluded" + } + } + }, + { + "name": "timestamp", + "type": "list[datetime]", + "description": "When the quote was published, as America/New_York time.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "DeribitOptionsChains", + "openapi_extra": { + "widget_config": { + "name": "Deribit Options Chains", + "description": "The full option chain of an underlying, with greeks and implied volatility.", + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 20 + }, + "params": [ + { + "paramName": "symbol", + "value": "BTC" + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "contract_symbol", + "headerName": "Contract", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "expiration", + "headerName": "Expiration", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike", + "headerName": "Strike", + "cellDataType": "number" + }, + { + "field": "option_type", + "headerName": "Type", + "cellDataType": "text" + }, + { + "field": "open_interest", + "headerName": "OI", + "cellDataType": "number" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number" + }, + { + "field": "volume_notional", + "headerName": "Volume Notional", + "cellDataType": "number" + }, + { + "field": "bid", + "headerName": "Bid", + "cellDataType": "number" + }, + { + "field": "bid_size", + "headerName": "Bid Size", + "cellDataType": "number" + }, + { + "field": "ask", + "headerName": "Ask", + "cellDataType": "number" + }, + { + "field": "ask_size", + "headerName": "Ask Size", + "cellDataType": "number" + }, + { + "field": "mark", + "headerName": "Mark", + "cellDataType": "number" + }, + { + "field": "last_trade_price", + "headerName": "Last", + "cellDataType": "number" + }, + { + "field": "high", + "headerName": "High", + "cellDataType": "number" + }, + { + "field": "low", + "headerName": "Low", + "cellDataType": "number" + }, + { + "field": "change_percent", + "headerName": "Change %", + "cellDataType": "number", + "formatterFn": "percent", + "renderFn": "greenRed" + }, + { + "field": "implied_volatility", + "headerName": "Mark IV", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "bid_iv", + "headerName": "Bid IV", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ask_iv", + "headerName": "Ask IV", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "delta", + "headerName": "Delta", + "cellDataType": "number" + }, + { + "field": "gamma", + "headerName": "Gamma", + "cellDataType": "number" + }, + { + "field": "theta", + "headerName": "Theta", + "cellDataType": "number" + }, + { + "field": "vega", + "headerName": "Vega", + "cellDataType": "number" + }, + { + "field": "rho", + "headerName": "Rho", + "cellDataType": "number" + }, + { + "field": "settlement_price", + "headerName": "Settlement Price", + "cellDataType": "number" + }, + { + "field": "min_price", + "headerName": "Min Price", + "cellDataType": "number" + }, + { + "field": "max_price", + "headerName": "Max Price", + "cellDataType": "number" + }, + { + "field": "interest_rate", + "headerName": "Interest Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "contract_size", + "headerName": "Contract Size", + "cellDataType": "number" + }, + { + "field": "is_inverse", + "headerName": "Is Inverse", + "cellDataType": "boolean" + }, + { + "field": "underlying_symbol", + "headerName": "Underlying", + "cellDataType": "text" + }, + { + "field": "underlying_price", + "headerName": "Underlying Forward", + "cellDataType": "number" + }, + { + "field": "underlying_spot_price", + "headerName": "Underlying Spot", + "cellDataType": "number" + }, + { + "field": "timestamp", + "headerName": "Timestamp", + "cellDataType": "text" + } + ] + } + } + }, + "model": "DeribitOptionsChains" + } + }, + "/deribit/options/optimizer": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Rank every combo structure against a view on the underlying.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Rank strategies for a move to 100,000 by year end.\nobb.deribit.options.optimizer(symbol='BTC', target_price=100000, target_date='2026-12-25')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "target_price", + "type": "float", + "description": "The price the underlying is expected to reach.", + "default": null, + "optional": true + }, + { + "name": "target_date", + "type": "str", + "description": "When it is expected to reach it.", + "default": null, + "optional": true + }, + { + "name": "budget", + "type": "float", + "description": "The capital to put at risk, in the quote currency. Each position is sized so its worst loss across a threefold move either way is this much.", + "default": 5000.0, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "How many structures to return, each at its best strikes.", + "default": 40, + "optional": true + }, + { + "name": "legs", + "type": "str", + "description": "The strategy picked from the Legs column, shared with the payoff chart. It does not change the ranking.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Strategy Optimizer", + "description": "Every Deribit combo structure the expiration can form, bought and sold, priced from its listed combo book where one trades, sized to the capital it puts at risk, and ranked by what it returns if the underlying reaches a price.", + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "strategy", + "headerName": "Strategy", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "code", + "headerName": "Combo Type", + "cellDataType": "text" + }, + { + "field": "legs", + "headerName": "Legs", + "cellDataType": "text", + "formatterFn": "none", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "legs" + } + } + }, + { + "field": "combo", + "headerName": "Listed Combo", + "cellDataType": "text" + }, + { + "field": "contracts", + "headerName": "Contracts", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Net Premium", + "cellDataType": "number" + }, + { + "field": "expected_profit", + "headerName": "Expected Profit", + "cellDataType": "number", + "renderFn": "greenRed" + }, + { + "field": "expected_return", + "headerName": "Expected Return", + "cellDataType": "number", + "formatterFn": "normalizedPercent", + "renderFn": "greenRed" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + } + ] + } + } + }, + "model": "" + } + }, + "/deribit/options/straddle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long straddle at each expiration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Price the BTC straddles.\nobb.deribit.options.straddle()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Straddle", + "description": "A long straddle at the money, priced at every expiration.", + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "strike", + "headerName": "Strike", + "cellDataType": "number" + }, + { + "field": "call_premium", + "headerName": "Call Premium", + "cellDataType": "number" + }, + { + "field": "put_premium", + "headerName": "Put Premium", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + } + ] + } + } + }, + "model": "" + } + }, + "/deribit/options/strangle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long strangle at each expiration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Price the BTC strangles.\nobb.deribit.options.strangle()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "How far out of the money each leg sits, in percent.", + "default": 5.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Strangle", + "description": "A long strangle out of the money, priced at every expiration.", + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "put_strike", + "headerName": "Put Strike", + "cellDataType": "number" + }, + { + "field": "call_strike", + "headerName": "Call Strike", + "cellDataType": "number" + }, + { + "field": "call_premium", + "headerName": "Call Premium", + "cellDataType": "number" + }, + { + "field": "put_premium", + "headerName": "Put Premium", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + } + ] + } + } + }, + "model": "" + } + }, + "/deribit/options/spreads": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a bull call and a bear put spread at each expiration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Price the BTC vertical spreads.\nobb.deribit.options.spreads()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "How far out the sold leg sits, in percent.", + "default": 5.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Vertical Spreads", + "description": "A bull call and a bear put spread at every expiration.", + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "strategy", + "headerName": "Strategy", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "expiration", + "headerName": "Expiration", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "bought_strike", + "headerName": "Bought Strike", + "cellDataType": "number" + }, + { + "field": "sold_strike", + "headerName": "Sold Strike", + "cellDataType": "number" + }, + { + "field": "bought_premium", + "headerName": "Bought Premium", + "cellDataType": "number" + }, + { + "field": "sold_premium", + "headerName": "Sold Premium", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven", + "headerName": "Breakeven", + "cellDataType": "number" + } + ] + } + } + }, + "model": "" + } + }, + "/deribit/options/strategy_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of the strategies the optimizer ranks for a view.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the strategies the optimizer ranks for a view.\nobb.deribit.options.strategy_choices(symbol='BTC')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "target_price", + "type": "float", + "description": "", + "default": null, + "optional": true + }, + { + "name": "target_date", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "budget", + "type": "float", + "description": "", + "default": 5000.0, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/deribit/options/payoff": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Draw what one position returns across a range of underlying prices.\n\n Raises\n ------\n HTTPException\n If the expiration lists no strategy, or does not list the position.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "target_price", + "type": "float", + "description": "The price the underlying is expected to reach.", + "default": null, + "optional": true + }, + { + "name": "target_date", + "type": "str", + "description": "When it is expected to reach it.", + "default": null, + "optional": true + }, + { + "name": "budget", + "type": "float", + "description": "The capital to put at risk, in the quote currency. Each position is sized so its worst loss across a threefold move either way is this much.", + "default": 5000.0, + "optional": true + }, + { + "name": "legs", + "type": "str", + "description": "The contracts to draw, as 'Buy SYMBOL / Sell 2 SYMBOL'. Click the Legs cell of a strategy in the optimizer to set it, or pick one here. Left empty, the best strategy for the view is drawn.", + "default": null, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Options Payoff", + "description": "What one ranked strategy returns across a range of underlying prices.", + "type": "chart", + "raw": true, + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/deribit/options/smile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility smile / skew across strikes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "expirations", + "type": "str", + "description": "Up to five expiration dates (comma-separated).", + "default": null, + "optional": true + }, + { + "name": "otm", + "type": "bool", + "description": "Show only out-of-the-money contracts.", + "default": false, + "optional": true + }, + { + "name": "skew", + "type": "bool", + "description": "Plot skew relative to ATM instead of IV.", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Volatility Smile", + "description": "Implied volatility smile or skew across strikes, per expiration.", + "type": "chart", + "raw": true, + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "refetchInterval": false + } + } + }, + "/deribit/options/term_structure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price or IV term structure across expirations.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM per expiry.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent out-of-the-money instead of a fixed strike.", + "default": null, + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Implied volatility or price.", + "default": "iv", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "Which side of the chain to plot.", + "default": "both", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Volatility Term Structure", + "description": "Price or implied volatility at one strike across expirations.", + "type": "chart", + "raw": true, + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "refetchInterval": false + } + } + }, + "/deribit/options/surface": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility or greeks 3-D surface over DTE and strike.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "The surface metric.", + "default": "implied_volatility", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "Which side of the chain to plot.", + "default": "otm", + "optional": true + }, + { + "name": "dte_min", + "type": "int", + "description": "Minimum days to expiry.", + "default": null, + "optional": true + }, + { + "name": "dte_max", + "type": "int", + "description": "Maximum days to expiry.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent from the underlying price to include.", + "default": null, + "optional": true + }, + { + "name": "oi", + "type": "bool", + "description": "Drop contracts with no open interest.", + "default": false, + "optional": true + }, + { + "name": "volume", + "type": "bool", + "description": "Drop contracts that have not traded.", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Volatility Surface", + "description": "Implied volatility or a greek as a surface over DTE and strike.", + "type": "chart", + "raw": true, + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 20 + }, + "refetchInterval": false + } + } + }, + "/deribit/options/stats": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open-interest or volume statistics by strike or expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying root, as it appears in the instrument name.", + "default": "BTC", + "optional": true + }, + { + "name": "by", + "type": "str", + "description": "Aggregate by strike or expiration.", + "default": "expiration", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Open interest or volume.", + "default": "oi", + "optional": true + }, + { + "name": "date", + "type": "str", + "description": "Expiry to view by strike (switches 'by' to strike).", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Raw values, share of total, or put/call ratio.", + "default": "value", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Deribit Options Statistics", + "description": "Open interest and volume, split between calls and puts.", + "type": "chart", + "raw": true, + "category": "Crypto", + "subCategory": "Options", + "source": [ + "Deribit" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "refetchInterval": false + } + } + }, + "/ecb/list_dataflows": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List all ECB SDMX dataflows in the catalogue.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # List every ECB dataflow.\n >>> obb.ecb.list_dataflows()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List every ECB dataflow.\nobb.ecb.list_dataflows()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Dataflows", + "description": "The catalogue of ECB SDMX dataflows.", + "type": "table", + "category": "ECB", + "subCategory": "Catalogue", + "source": [ + "ECB" + ], + "gridData": { + "w": 30, + "h": 15 + } + }, + "model": "" + } + }, + "/ecb/search_dataflows": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the ECB dataflow catalogue; an empty query lists every dataflow.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List every ECB dataflow.\nobb.ecb.search_dataflows()\n# Search dataflows by keyword.\nobb.ecb.search_dataflows(query='interest rate')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search dataflows by id/name/description (+ AND, | OR).", + "default": null, + "optional": true + }, + { + "name": "dataflow", + "type": "str", + "description": "Selected dataflow (set by clicking a row).", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Dataflow Search", + "description": "Search the ECB dataflow catalogue \u2014 click a row to explore it.", + "type": "table", + "category": "ECB", + "subCategory": "Catalogue", + "source": [ + "ECB" + ], + "gridData": { + "w": 30, + "h": 15 + }, + "params": [ + { + "paramName": "query", + "label": "Query", + "value": null, + "description": "Search by id, name, or description (+ AND, | OR). Empty lists every dataflow.", + "type": "text" + }, + { + "paramName": "dataflow", + "label": "Dataflow", + "description": "Selected dataflow (set by clicking a result row).", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/list_dataflows", + "style": { + "popupWidth": 600 + } + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "value", + "headerName": "Dataflow", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "dataflow" + } + } + ] + } + } + }, + "model": "" + } + }, + "/ecb/list_topics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value, count}] for every ECB topic that has dataflows.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # List ECB topics for dropdowns.\n >>> obb.ecb.list_topics()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List ECB topics for dropdowns.\nobb.ecb.list_topics()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/ecb/topic_dataflows": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return the dataflows categorised under a topic, as table rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List the dataflows under a topic.\nobb.ecb.topic_dataflows(topic_id='07')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "topic_id", + "type": "str", + "description": "The topic (category) id.", + "default": null, + "optional": false + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Topic Dataflows", + "description": "The dataflows grouped under an ECB topic.", + "type": "table", + "category": "ECB", + "subCategory": "Catalogue", + "source": [ + "ECB" + ], + "gridData": { + "w": 20, + "h": 12 + }, + "params": [ + { + "paramName": "topic_id", + "label": "Topic", + "value": "07", + "description": "The ECB topic.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/list_topics" + } + ] + }, + "model": "" + } + }, + "/ecb/list_concepts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return the ECB data-portal concepts with their dataset members.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # List ECB concepts (topics).\n >>> obb.ecb.list_concepts()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List ECB concepts (topics).\nobb.ecb.list_concepts()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Concepts", + "description": "The ECB data-portal concepts (topics) and the number of datasets each one groups.", + "type": "table", + "category": "ECB", + "subCategory": "Catalogue", + "source": [ + "ECB" + ], + "gridData": { + "w": 20, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "name", + "headerName": "Concept" + }, + { + "field": "count", + "headerName": "Datasets" + } + ] + } + } + }, + "model": "" + } + }, + "/ecb/get_dataflow_dimensions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return the ordered dimensions of a dataflow with their codelist values.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Discover the queryable dimensions of a dataflow.\nobb.ecb.get_dataflow_dimensions(dataflow='EXR')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataflow", + "type": "str", + "description": "The ECB dataflow id, e.g. 'EXR'.", + "default": null, + "optional": false + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Dataflow Dimensions", + "description": "The queryable dimensions and codelist values of a dataflow.", + "type": "table", + "category": "ECB", + "subCategory": "Catalogue", + "source": [ + "ECB" + ], + "gridData": { + "w": 30, + "h": 20 + }, + "params": [ + { + "paramName": "dataflow", + "label": "Dataflow", + "value": "EXR", + "description": "The ECB dataflow to inspect.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/list_dataflows", + "style": { + "popupWidth": 600 + } + } + ] + }, + "model": "" + } + }, + "/ecb/dimension_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return ``[{label, value}]`` for one dimension, optionally narrowed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get options for one dimension, narrowed by prior selections.\nobb.ecb.dimension_choices(dataflow_id='EXR', dimension_id='CURRENCY')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataflow_id", + "type": "str", + "description": "The ECB dataflow id.", + "default": null, + "optional": false + }, + { + "name": "dimension_id", + "type": "str", + "description": "The dimension to list options for.", + "default": null, + "optional": false + }, + { + "name": "selections", + "type": "str", + "description": "Prior selections as 'DIM=VALUE,DIM=VALUE' to narrow the available options for this dimension.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/ecb/list_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the ECB data-portal presentation tables.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List ECB presentation tables.\nobb.ecb.list_tables()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "table_id", + "type": "str", + "description": "Selected table (set by clicking a row).", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Presentation Tables", + "description": "The ECB data-portal presentation (release) tables, grouped by the portal's publication tree \u2014 click a row to load it in the ECB Presentation Table widget.", + "type": "table", + "category": "ECB", + "subCategory": "Presentation Tables", + "source": [ + "ECB" + ], + "gridData": { + "w": 25, + "h": 15 + }, + "params": [ + { + "paramName": "table_id", + "label": "Table", + "description": "Selected table (set by clicking a row).", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/list_table_choices", + "style": { + "popupWidth": 700 + } + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "category", + "headerName": "Category" + }, + { + "field": "subcategory", + "headerName": "Subcategory" + }, + { + "field": "title", + "headerName": "Table" + }, + { + "field": "value", + "headerName": "Load", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "table_id" + } + } + ] + } + } + }, + "model": "" + } + }, + "/ecb/presentation_table": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Resolve a presentation table to indented rows with recent periods pivoted.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The euro area MFI balance sheet.\nobb.ecb.presentation_table(table_id='HCL_JDF_BSI_MFI_BALANCE_SHEET@HCL_BSI')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "table_id", + "type": "str", + "description": "The presentation table id.", + "default": null, + "optional": false + }, + { + "name": "frequency", + "type": "str", + "description": "Observation frequency code (e.g. 'M').", + "default": null, + "optional": true + }, + { + "name": "reference_area", + "type": "str", + "description": "Reference area / currency code (e.g. 'U2').", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Number of recent periods to show as columns.", + "default": 8, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Presentation Table", + "description": "An ECB data-portal presentation (release) table. Every published series is a row \u2014 its title, full definition on hover, unit, and the most recent periods pivoted into columns as real, unit-scaled numbers.", + "type": "table", + "category": "ECB", + "subCategory": "Presentation Tables", + "source": [ + "ECB" + ], + "gridData": { + "w": 40, + "h": 20 + }, + "params": [ + { + "paramName": "table_id", + "label": "Table", + "value": "HCL_JDF_BSI_MFI_BALANCE_SHEET@HCL_BSI", + "description": "The ECB presentation table.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/list_table_choices", + "style": { + "popupWidth": 700 + } + }, + { + "paramName": "frequency", + "label": "Frequency", + "description": "Observation frequency (hierarchical tables only).", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/presentation_table_frequencies", + "optionsParams": { + "table_id": "$table_id" + } + }, + { + "paramName": "reference_area", + "label": "Reference area", + "description": "Reference area or currency (hierarchical tables only).", + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/presentation_table_areas", + "optionsParams": { + "table_id": "$table_id" + }, + "style": { + "popupWidth": 500 + } + }, + { + "paramName": "limit", + "label": "Periods", + "value": 8, + "description": "Number of recent periods to show as columns.", + "type": "number" + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "title", + "headerName": "Series", + "pinned": "left", + "cellDataType": "text", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "title", + "title": "Series definition", + "markdown": "{description}" + } + } + }, + { + "field": "description", + "headerName": "Definition", + "hide": true + }, + { + "field": "unit", + "headerName": "Unit", + "pinned": "left", + "cellDataType": "text", + "width": 90 + } + ] + } + } + }, + "model": "" + } + }, + "/ecb/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the ECB SDMX catalogue of dataflows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.available_indicators(provider='ecb')\n# Search the catalogue.\nobb.ecb.available_indicators(provider='ecb', query='interest rate')\n```\n\n", + "parameters": { + "standard": [], + "ecb": [ + { + "name": "dataflow", + "type": "str | None", + "description": "The ECB dataflow whose series (indicators) to enumerate, e.g. 'ICP'. Use `list_dataflows` / `search_dataflows` to find one.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/list_dataflows", + "multiSelect": false, + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Observation frequency code to narrow to (e.g. 'M').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/indicator_frequencies", + "optionsParams": { + "dataflow": "$dataflow" + } + } + } + }, + { + "name": "reference_area", + "type": "str | None", + "description": "Reference area / currency code to narrow to (e.g. 'U2').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/indicator_areas", + "optionsParams": { + "dataflow": "$dataflow" + }, + "style": { + "popupWidth": 500 + } + } + } + }, + { + "name": "dimension_values", + "type": "list[str] | str | None | list[list[str] | str | None]", + "description": "Additional 'DIM:VALUE' filters for dataflow-specific dimensions (e.g. 'ICP_ITEM:000000'), beyond frequency / reference area. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Other Dimensions", + "type": "text", + "multiple": true, + "value": null, + "description": "Additional 'DIM:VALUE' filters for the dataflow's other dimensions \u2014 see the ECB Dataflow Dimensions widget for the ids and codes, e.g. 'ICP_ITEM:000000'." + } + } + }, + { + "name": "query", + "type": "str | None", + "description": "Filter series by text in the indicator name. Supports '+' (AND), '|' (OR), and 'quoted phrases'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of series to return (None or <=0 returns all).", + "default": 500, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the parsed-data disk cache for the enumerated series.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Dummy field so a clicked series can group by symbol.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AvailableEcbIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol_root", + "type": "str | None", + "description": "The root symbol representing the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The name of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "iso", + "type": "str | None", + "description": "The ISO code of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The description of the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the indicator data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "dataflow_id", + "type": "str | None", + "description": "The ECB dataflow the series belongs to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_key", + "type": "str | None", + "description": "The SDMX series key (the dot-joined dimension codes).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "AvailableEcbIndicators", + "openapi_extra": { + "model": "AvailableEcbIndicators" + } + }, + "/ecb/indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch any ECB SDMX series by a 'FLOW::KEY' symbol.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fetch any ECB series by 'FLOW::KEY' symbol.\nobb.ecb.indicators(provider='ecb', symbol='EXR::D.USD.EUR.SP00.A')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): ecb.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "ecb": { + "multiple_items_allowed": true + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "The country to get data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol_root", + "type": "str | None", + "description": "The root symbol for the indicator (e.g. GDP).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country represented by the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "title", + "type": "str | None", + "description": "Descriptive series title.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The series frequency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of the observation.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "EcbIndicators", + "openapi_extra": { + "model": "EcbIndicators" + } + }, + "/ecb/balance_of_payments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro area balance of payments statistics.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.balance_of_payments(provider='ecb')\n```\n\n", + "parameters": { + "standard": [], + "ecb": [ + { + "name": "report_type", + "type": "str | None", + "description": "The report type, the level of detail in the data.", + "default": "main", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data. Monthly is valid only for ['main', 'summary'].", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country/region of the data. This parameter will override the 'report_type' parameter.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbBalanceOfPayments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "date | None", + "description": "The date representing the beginning of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_account", + "type": "float | None", + "description": "Current Account Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods", + "type": "float | None", + "description": "Goods Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services", + "type": "float | None", + "description": "Services Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_income", + "type": "float | None", + "description": "Primary Income Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "secondary_income", + "type": "float | None", + "description": "Secondary Income Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_account", + "type": "float | None", + "description": "Capital Account Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_lending_to_rest_of_world", + "type": "float | None", + "description": "Balance of net lending to the rest of the world (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_account", + "type": "float | None", + "description": "Financial Account Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_investment", + "type": "float | None", + "description": "Direct Investment Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portfolio_investment", + "type": "float | None", + "description": "Portfolio Investment Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_derivatives", + "type": "float | None", + "description": "Financial Derivatives Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_investment", + "type": "float | None", + "description": "Other Investment Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reserve_assets", + "type": "float | None", + "description": "Reserve Assets Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "errors_and_omissions", + "type": "float | None", + "description": "Errors and Omissions (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_account_credit", + "type": "float | None", + "description": "Current Account Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_account_debit", + "type": "float | None", + "description": "Current Account Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_account_balance", + "type": "float | None", + "description": "Current Account Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods_credit", + "type": "float | None", + "description": "Goods Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods_debit", + "type": "float | None", + "description": "Goods Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_credit", + "type": "float | None", + "description": "Services Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_debit", + "type": "float | None", + "description": "Services Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_income_credit", + "type": "float | None", + "description": "Primary Income Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_income_employee_compensation_credit", + "type": "float | None", + "description": "Primary Income Employee Compensation Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_income_debit", + "type": "float | None", + "description": "Primary Income Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_income_employee_compensation_debit", + "type": "float | None", + "description": "Primary Income Employee Compensation Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "secondary_income_credit", + "type": "float | None", + "description": "Secondary Income Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "secondary_income_debit", + "type": "float | None", + "description": "Secondary Income Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_account_credit", + "type": "float | None", + "description": "Capital Account Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_account_debit", + "type": "float | None", + "description": "Capital Account Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_total_credit", + "type": "float | None", + "description": "Services Total Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_total_debit", + "type": "float | None", + "description": "Services Total Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transport_credit", + "type": "float | None", + "description": "Transport Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transport_debit", + "type": "float | None", + "description": "Transport Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "travel_credit", + "type": "float | None", + "description": "Travel Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "travel_debit", + "type": "float | None", + "description": "Travel Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_services_credit", + "type": "float | None", + "description": "Financial Services Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_services_debit", + "type": "float | None", + "description": "Financial Services Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "communications_credit", + "type": "float | None", + "description": "Communications Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "communications_debit", + "type": "float | None", + "description": "Communications Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_business_services_credit", + "type": "float | None", + "description": "Other Business Services Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_business_services_debit", + "type": "float | None", + "description": "Other Business Services Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_services_credit", + "type": "float | None", + "description": "Other Services Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_services_debit", + "type": "float | None", + "description": "Other Services Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_total_credit", + "type": "float | None", + "description": "Investment Total Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_total_debit", + "type": "float | None", + "description": "Investment Total Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_credit", + "type": "float | None", + "description": "Equity Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_reinvested_earnings_credit", + "type": "float | None", + "description": "Equity Reinvested Earnings Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_debit", + "type": "float | None", + "description": "Equity Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_reinvested_earnings_debit", + "type": "float | None", + "description": "Equity Reinvested Earnings Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debt_instruments_credit", + "type": "float | None", + "description": "Debt Instruments Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debt_instruments_debit", + "type": "float | None", + "description": "Debt Instruments Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portfolio_investment_equity_credit", + "type": "float | None", + "description": "Portfolio Investment Equity Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portfolio_investment_equity_debit", + "type": "float | None", + "description": "Portfolio Investment Equity Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portfolio_investment_debt_instruments_credit", + "type": "float | None", + "description": "Portfolio Investment Debt Instruments Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portofolio_investment_debt_instruments_debit", + "type": "float | None", + "description": "Portfolio Investment Debt Instruments Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_investment_credit", + "type": "float | None", + "description": "Other Investment Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_investment_debit", + "type": "float | None", + "description": "Other Investment Debit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reserve_assets_credit", + "type": "float | None", + "description": "Reserve Assets Credit (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_total", + "type": "float | None", + "description": "Assets Total (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_equity", + "type": "float | None", + "description": "Assets Equity (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_debt_instruments", + "type": "float | None", + "description": "Assets Debt Instruments (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_mfi", + "type": "float | None", + "description": "Assets MFIs (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_non_mfi", + "type": "float | None", + "description": "Assets Non MFIs (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_direct_investment_abroad", + "type": "float | None", + "description": "Assets Direct Investment Abroad (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_total", + "type": "float | None", + "description": "Liabilities Total (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_equity", + "type": "float | None", + "description": "Liabilities Equity (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_debt_instruments", + "type": "float | None", + "description": "Liabilities Debt Instruments (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_mfi", + "type": "float | None", + "description": "Liabilities MFIs (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_non_mfi", + "type": "float | None", + "description": "Liabilities Non MFIs (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_direct_investment_euro_area", + "type": "float | None", + "description": "Liabilities Direct Investment in Euro Area (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_equity_and_fund_shares", + "type": "float | None", + "description": "Assets Equity and Investment Fund Shares (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_equity_shares", + "type": "float | None", + "description": "Assets Equity Shares (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_investment_fund_shares", + "type": "float | None", + "description": "Assets Investment Fund Shares (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_debt_short_term", + "type": "float | None", + "description": "Assets Debt Short Term (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_debt_long_term", + "type": "float | None", + "description": "Assets Debt Long Term (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_resident_sector_eurosystem", + "type": "float | None", + "description": "Assets Resident Sector Eurosystem (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_resident_sector_mfi_ex_eurosystem", + "type": "float | None", + "description": "Assets Resident Sector MFIs outside Eurosystem (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_resident_sector_government", + "type": "float | None", + "description": "Assets Resident Sector Government (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_resident_sector_other", + "type": "float | None", + "description": "Assets Resident Sector Other (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_equity_and_fund_shares", + "type": "float | None", + "description": "Liabilities Equity and Investment Fund Shares (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_investment_fund_shares", + "type": "float | None", + "description": "Liabilities Investment Fund Shares (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_debt_short_term", + "type": "float | None", + "description": "Liabilities Debt Short Term (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_debt_long_term", + "type": "float | None", + "description": "Liabilities Debt Long Term (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_resident_sector_government", + "type": "float | None", + "description": "Liabilities Resident Sector Government (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_resident_sector_other", + "type": "float | None", + "description": "Liabilities Resident Sector Other (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_currency_and_deposits", + "type": "float | None", + "description": "Assets Currency and Deposits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_loans", + "type": "float | None", + "description": "Assets Loans (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_trade_credit_and_advances", + "type": "float | None", + "description": "Assets Trade Credits and Advances (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_eurosystem", + "type": "float | None", + "description": "Assets Eurosystem (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_other_mfi_ex_eurosystem", + "type": "float | None", + "description": "Assets Other MFIs outside Eurosystem (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_government", + "type": "float | None", + "description": "Assets Government (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets_other_sectors", + "type": "float | None", + "description": "Assets Other Sectors (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_currency_and_deposits", + "type": "float | None", + "description": "Liabilities Currency and Deposits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_loans", + "type": "float | None", + "description": "Liabilities Loans (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_trade_credit_and_advances", + "type": "float | None", + "description": "Liabilities Trade Credits and Advances (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_eurosystem", + "type": "float | None", + "description": "Liabilities Eurosystem (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_other_mfi_ex_eurosystem", + "type": "float | None", + "description": "Liabilities Other MFIs outside Eurosystem (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_government", + "type": "float | None", + "description": "Liabilities Government (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities_other_sectors", + "type": "float | None", + "description": "Liabilities Other Sectors (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods_balance", + "type": "float | None", + "description": "Goods Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_balance", + "type": "float | None", + "description": "Services Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_income_balance", + "type": "float | None", + "description": "Primary Income Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_income_balance", + "type": "float | None", + "description": "Investment Income Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_income_credit", + "type": "float | None", + "description": "Investment Income Credits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_income_debit", + "type": "float | None", + "description": "Investment Income Debits (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "secondary_income_balance", + "type": "float | None", + "description": "Secondary Income Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_account_balance", + "type": "float | None", + "description": "Capital Account Balance (Billions of EUR)", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "ecb": [] + }, + "model": "EcbBalanceOfPayments", + "openapi_extra": { + "model": "EcbBalanceOfPayments" + } + }, + "/ecb/calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the ECB statistical release calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.calendar(provider='ecb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "dataflow", + "type": "str | None", + "description": "Dummy field so a clicked release can group by dataflow.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbReleaseCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Category of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "event", + "type": "str | None", + "description": "Event name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "importance", + "type": "str | None", + "description": "The importance level for the event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Source of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus", + "type": "float | str | None", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous", + "type": "float | str | None", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revised", + "type": "float | str | None", + "description": "Revised previous value, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "actual", + "type": "float | str | None", + "description": "Latest released value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "ecb": [] + }, + "model": "EcbReleaseCalendar", + "openapi_extra": { + "model": "EcbReleaseCalendar" + } + }, + "/ecb/exchange_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro foreign-exchange reference rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.exchange_rates(provider='ecb', symbol='EURUSD')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): ecb.", + "default": null, + "optional": false, + "choices": [ + "EURAED", + "EURARS", + "EURAUD", + "EURBGN", + "EURBRL", + "EURCAD", + "EURCHF", + "EURCLP", + "EURCNY", + "EURCOP", + "EURCYP", + "EURCZK", + "EURDKK", + "EURDZD", + "EURE01", + "EURE02", + "EURE03", + "EUREEK", + "EUREGP", + "EURGBP", + "EURGRD", + "EURH00", + "EURH01", + "EURH02", + "EURH03", + "EURH37", + "EURH42", + "EURHKD", + "EURHRK", + "EURHUF", + "EURIDR", + "EURILS", + "EURINR", + "EURISK", + "EURJPY", + "EURKRW", + "EURLTL", + "EURLVL", + "EURMAD", + "EURMTL", + "EURMXN", + "EURMYR", + "EURNOK", + "EURNZD", + "EURPEN", + "EURPHP", + "EURPLN", + "EURRON", + "EURRUB", + "EURSAR", + "EURSEK", + "EURSGD", + "EURSIT", + "EURSKK", + "EURTHB", + "EURTRY", + "EURTWD", + "EURUAH", + "EURUSD", + "EURZAR" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "ecb": { + "multiple_items_allowed": true, + "choices": [ + "EURAED", + "EURARS", + "EURAUD", + "EURBGN", + "EURBRL", + "EURCAD", + "EURCHF", + "EURCLP", + "EURCNY", + "EURCOP", + "EURCYP", + "EURCZK", + "EURDKK", + "EURDZD", + "EURE01", + "EURE02", + "EURE03", + "EUREEK", + "EUREGP", + "EURGBP", + "EURGRD", + "EURH00", + "EURH01", + "EURH02", + "EURH03", + "EURH37", + "EURH42", + "EURHKD", + "EURHRK", + "EURHUF", + "EURIDR", + "EURILS", + "EURINR", + "EURISK", + "EURJPY", + "EURKRW", + "EURLTL", + "EURLVL", + "EURMAD", + "EURMTL", + "EURMXN", + "EURMYR", + "EURNOK", + "EURNZD", + "EURPEN", + "EURPHP", + "EURPLN", + "EURRON", + "EURRUB", + "EURSAR", + "EURSEK", + "EURSGD", + "EURSIT", + "EURSKK", + "EURTHB", + "EURTRY", + "EURTWD", + "EURUAH", + "EURUSD", + "EURZAR" + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the reference exchange rates.", + "default": "daily", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbCurrencyHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "ecb": [] + }, + "model": "EcbCurrencyHistorical", + "openapi_extra": { + "model": "EcbCurrencyHistorical" + } + }, + "/ecb/reference_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest euro foreign-exchange reference rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.reference_rates(provider='ecb')\n```\n\n", + "parameters": { + "standard": [], + "ecb": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbCurrencyReferenceRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "EUR", + "type": "float | None", + "description": "Euro.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "USD", + "type": "float | None", + "description": "US Dollar.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "JPY", + "type": "float | None", + "description": "Japanese Yen.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "BGN", + "type": "float | None", + "description": "Bulgarian Lev.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "CZK", + "type": "float | None", + "description": "Czech Koruna.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "DKK", + "type": "float | None", + "description": "Danish Krone.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "GBP", + "type": "float | None", + "description": "Pound Sterling.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "HUF", + "type": "float | None", + "description": "Hungarian Forint.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "PLN", + "type": "float | None", + "description": "Polish Zloty.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "RON", + "type": "float | None", + "description": "Romanian Leu.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "SEK", + "type": "float | None", + "description": "Swedish Krona.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "CHF", + "type": "float | None", + "description": "Swiss Franc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ISK", + "type": "float | None", + "description": "Icelandic Krona.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "NOK", + "type": "float | None", + "description": "Norwegian Krone.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "TRY", + "type": "float | None", + "description": "Turkish Lira.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "AUD", + "type": "float | None", + "description": "Australian Dollar.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "BRL", + "type": "float | None", + "description": "Brazilian Real.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "CAD", + "type": "float | None", + "description": "Canadian Dollar.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "CNY", + "type": "float | None", + "description": "Chinese Yuan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "HKD", + "type": "float | None", + "description": "Hong Kong Dollar.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "IDR", + "type": "float | None", + "description": "Indonesian Rupiah.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ILS", + "type": "float | None", + "description": "Israeli Shekel.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "INR", + "type": "float | None", + "description": "Indian Rupee.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "KRW", + "type": "float | None", + "description": "South Korean Won.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "MXN", + "type": "float | None", + "description": "Mexican Peso.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "MYR", + "type": "float | None", + "description": "Malaysian Ringgit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "NZD", + "type": "float | None", + "description": "New Zealand Dollar.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "PHP", + "type": "float | None", + "description": "Philippine Peso.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "SGD", + "type": "float | None", + "description": "Singapore Dollar.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "THB", + "type": "float | None", + "description": "Thai Baht.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ZAR", + "type": "float | None", + "description": "South African Rand.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "ecb": [] + }, + "model": "EcbCurrencyReferenceRates", + "openapi_extra": { + "model": "EcbCurrencyReferenceRates" + } + }, + "/ecb/yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro area government bond yield curve.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.yield_curve(provider='ecb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. By default is the current data. Multiple items allowed for provider(s): ecb.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "ecb": { + "multiple_items_allowed": true + } + } + } + ], + "ecb": [ + { + "name": "rating", + "type": "str | None", + "description": "The rating type, either 'aaa' or 'all_ratings'.", + "default": "aaa", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "yield_curve_type", + "type": "str | None", + "description": "The yield curve type.", + "default": "spot_rate", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbYieldCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "ecb": [] + }, + "model": "EcbYieldCurve", + "openapi_extra": { + "model": "EcbYieldCurve" + } + }, + "/ecb/euro_short_term_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the euro short-term rate and its detail.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.euro_short_term_rate(provider='ecb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbEuroShortTermRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Volume-weighted trimmed mean rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "Rate at 25th percentile of volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "Rate at 75th percentile of volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume. (Millions of \u20acEUR).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000.0 + } + }, + { + "name": "transactions", + "type": "int | None", + "description": "Number of transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_banks", + "type": "int | None", + "description": "Number of active banks.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "large_bank_share_of_volume", + "type": "float | None", + "description": "The percent of volume attributable to the 5 largest active banks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "ecb": [] + }, + "model": "EcbEuroShortTermRate", + "openapi_extra": { + "model": "EcbEuroShortTermRate" + } + }, + "/ecb/key_interest_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the key ECB interest rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.key_interest_rates(provider='ecb')\n```\n\n", + "parameters": { + "standard": [], + "ecb": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data window.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data window.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbKeyInterestRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "ecb": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "deposit_facility", + "type": "float | None", + "description": "Deposit facility, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Deposit facility" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "main_refinancing", + "type": "float | None", + "description": "Main refinancing operations, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Main refinancing operations" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "marginal_lending", + "type": "float | None", + "description": "Marginal lending facility, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Marginal lending facility" + }, + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "EcbKeyInterestRates", + "openapi_extra": { + "model": "EcbKeyInterestRates" + } + }, + "/ecb/mfi_interest_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "MFI interest rates on euro-area loans and deposits.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.mfi_interest_rates(provider='ecb')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): ecb.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "ecb": { + "multiple_items_allowed": true, + "choices": [ + "household_overnight_deposits", + "household_deposits_with_agreed_maturity", + "household_deposits_redeemable_at_notice", + "household_loans_for_house_purchase", + "household_loans_for_house_purchase_cost_of_borrowing", + "household_consumer_credit", + "household_other_loans", + "corporate_overnight_deposits", + "corporate_deposits_with_agreed_maturity", + "corporate_loans", + "corporate_loans_cost_of_borrowing", + "household_loans_outstanding", + "household_house_purchase_outstanding", + "household_consumer_and_other_outstanding" + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "The country to get data.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "ecb": { + "choices": [ + "U2", + "AT", + "BE", + "BG", + "CY", + "CZ", + "DE", + "DK", + "EE", + "ES", + "FI", + "FR", + "GR", + "HR", + "HU", + "IE", + "IT", + "LT", + "LU", + "LV", + "MT", + "NL", + "PL", + "PT", + "RO", + "SE", + "SI", + "SK" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "ecb": [ + { + "name": "symbol", + "type": "str | None", + "description": "Headline MFI rate series to include as columns (default: all). One or more of: household_overnight_deposits, household_deposits_with_agreed_maturity, household_deposits_redeemable_at_notice, household_loans_for_house_purchase, household_loans_for_house_purchase_cost_of_borrowing, household_consumer_credit, household_other_loans, corporate_overnight_deposits, corporate_deposits_with_agreed_maturity, corporate_loans, corporate_loans_cost_of_borrowing, household_loans_outstanding, household_house_purchase_outstanding, household_consumer_and_other_outstanding", + "default": "household_overnight_deposits,household_deposits_with_agreed_maturity,household_deposits_redeemable_at_notice,household_loans_for_house_purchase,household_loans_for_house_purchase_cost_of_borrowing,household_consumer_credit,household_other_loans,corporate_overnight_deposits,corporate_deposits_with_agreed_maturity,corporate_loans,corporate_loans_cost_of_borrowing,household_loans_outstanding,household_house_purchase_outstanding,household_consumer_and_other_outstanding", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Reference area: 'U2' (euro area) or an ISO country code (e.g. 'DE', 'FR') for national data.", + "default": "U2", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache parsed results on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbMfiInterestRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "ecb": [ + { + "name": "date", + "type": "date | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "household_overnight_deposits", + "type": "float | None", + "description": "Households \u2013 overnight deposits, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 overnight deposits" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_deposits_with_agreed_maturity", + "type": "float | None", + "description": "Households \u2013 deposits with agreed maturity, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 deposits with agreed maturity" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_deposits_redeemable_at_notice", + "type": "float | None", + "description": "Households \u2013 deposits redeemable at notice, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 deposits redeemable at notice" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_loans_for_house_purchase", + "type": "float | None", + "description": "Households \u2013 loans for house purchase, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 loans for house purchase" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_loans_for_house_purchase_cost_of_borrowing", + "type": "float | None", + "description": "Households \u2013 house purchase (cost of borrowing), in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 house purchase (cost of borrowing)" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_consumer_credit", + "type": "float | None", + "description": "Households \u2013 consumer credit, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 consumer credit" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_other_loans", + "type": "float | None", + "description": "Households \u2013 other loans, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 other loans" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "corporate_overnight_deposits", + "type": "float | None", + "description": "NFCs \u2013 overnight deposits, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "NFCs \u2013 overnight deposits" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "corporate_deposits_with_agreed_maturity", + "type": "float | None", + "description": "NFCs \u2013 deposits with agreed maturity, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "NFCs \u2013 deposits with agreed maturity" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "corporate_loans", + "type": "float | None", + "description": "NFCs \u2013 loans, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "NFCs \u2013 loans" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "corporate_loans_cost_of_borrowing", + "type": "float | None", + "description": "NFCs \u2013 loans (cost of borrowing), in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "NFCs \u2013 loans (cost of borrowing)" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_loans_outstanding", + "type": "float | None", + "description": "Households \u2013 loans outstanding, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 loans outstanding" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_house_purchase_outstanding", + "type": "float | None", + "description": "Households \u2013 house purchase outstanding, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 house purchase outstanding" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "household_consumer_and_other_outstanding", + "type": "float | None", + "description": "Households \u2013 consumer & other outstanding, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Households \u2013 consumer & other outstanding" + }, + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "EcbMfiInterestRates", + "openapi_extra": { + "widget_config": { + "name": "ECB MFI Interest Rates", + "description": "Euro-area bank (MFI) interest rates on household and NFC loans and deposits \u2014 one column per headline rate (monthly).", + "type": "table", + "category": "ECB", + "subCategory": "Interest Rates", + "source": [ + "ECB" + ], + "gridData": { + "w": 40, + "h": 15 + }, + "params": [ + { + "paramName": "symbol", + "show": false + }, + { + "paramName": "frequency", + "show": false + } + ] + }, + "model": "EcbMfiInterestRates" + } + }, + "/ecb/dataflow_information": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render a dataset's rich ECB reference metadata as an HTML page.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "concept", + "type": "str", + "description": "", + "default": "", + "optional": true + }, + { + "name": "dataflow", + "type": "str", + "description": "", + "default": "", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Dataset Information", + "description": "The ECB's full reference metadata for a dataset \u2014 scope, methodology, statistical processing, legal basis, dissemination and the downloadable series catalogue.", + "category": "ECB", + "subCategory": "Catalogue", + "type": "html", + "widgetId": "ecb_dataflow_information", + "params": [ + { + "paramName": "concept", + "label": "Concept", + "show": true, + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/concept_choices", + "style": { + "popupWidth": 400 + } + }, + { + "paramName": "dataflow", + "label": "Dataset", + "show": true, + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/dataflow_info_choices", + "optionsParams": { + "concept": "$concept" + }, + "style": { + "popupWidth": 600 + } + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 40, + "h": 24 + }, + "refetchInterval": false + } + } + }, + "/ecb/release_document": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render one ECB release as a full HTML page for the Workspace HTML widget.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "category", + "type": "str", + "description": "", + "default": "blog", + "optional": true + }, + { + "name": "release", + "type": "str", + "description": "", + "default": "", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "ECB Release Viewer", + "description": "Read any ECB press release, publication, or blog post in full \u2014 charts, tables and images included.", + "category": "ECB", + "subCategory": "Releases", + "type": "html", + "widgetId": "ecb_release_document", + "params": [ + { + "paramName": "category", + "label": "Feed", + "show": true, + "value": "blog", + "options": [ + { + "label": "Press releases", + "value": "press_releases" + }, + { + "label": "Publications", + "value": "publications" + }, + { + "label": "Blog", + "value": "blog" + } + ] + }, + { + "paramName": "release", + "label": "Release", + "show": true, + "type": "endpoint", + "optionsEndpoint": "/api/v1/ecb/release_choices", + "optionsParams": { + "category": "$category" + }, + "style": { + "popupWidth": 800 + } + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 40, + "h": 24 + }, + "refetchInterval": false + } + } + }, + "/ecb/eligible_assets": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Eurosystem list of eligible marketable assets.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ecb.eligible_assets(provider='ecb', currency='EUR', limit=10)\n```\n\n", + "parameters": { + "standard": [], + "ecb": [ + { + "name": "date", + "type": "date | None | str", + "description": "Snapshot date. Defaults to the latest available business day.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None | list[str | None]", + "description": "Filter by one or more ISIN codes. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Filter by asset type (e.g. 'Bond').", + "default": null, + "optional": true, + "choices": [ + "Bond", + "Medium-term note", + "Treasury bill / commercial paper / certificate of deposit", + "EEA legislative covered bond", + "Asset-backed security (ABS)", + "Multi-c\u00e9dulas", + "Non-EEA G10 legislative covered bond" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "haircut_category", + "type": "str | None", + "description": "Filter by Eurosystem haircut (liquidity) category.", + "default": null, + "optional": true, + "choices": [ + "Category I \u2013 central government, EU, central banks", + "Category II \u2013 regional/local govt, agencies, supranationals, covered bonds", + "Category III \u2013 corporate and other issuers", + "Category IV \u2013 unsecured credit-institution debt", + "Category V \u2013 asset-backed securities" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Filter by denomination currency (e.g. 'EUR').", + "default": null, + "optional": true, + "choices": [ + "EUR", + "USD", + "GBP", + "JPY", + "ATS", + "DEM", + "HRK", + "SKK" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issuer_group", + "type": "str | None", + "description": "Filter by issuer group (e.g. 'Central government').", + "default": null, + "optional": true, + "choices": [ + "Central bank", + "Central government", + "Corporate and other issuers", + "Credit institution (excluding agencies)", + "Regional/local government", + "Supranational issuer", + "Agency \u2013 non-credit institution", + "Agency \u2013 credit institution", + "Financial corporation other than credit institution", + "Public corporation" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of assets returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If true, cache the parsed list on disk for the dataset TTL.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EcbEligibleAssets", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "ecb": [ + { + "name": "isin", + "type": "str", + "description": "International Securities Identification Number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Asset type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "haircut_category", + "type": "str | None", + "description": "Eurosystem haircut (liquidity) category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "haircut", + "type": "float | None", + "description": "Valuation haircut, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "haircut_own_use", + "type": "float | None", + "description": "Own-use valuation haircut, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reference_market", + "type": "str | None", + "description": "Reference market.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Denomination currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_rate", + "type": "float | None", + "description": "Coupon rate, percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_definition", + "type": "str | None", + "description": "Coupon definition (Fixed, Variable, or Zero).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuance_date", + "type": "date | None", + "description": "Issuance date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Maturity date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_name", + "type": "str | None", + "description": "Issuer name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_residence", + "type": "str | None", + "description": "Issuer country of residence.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_group", + "type": "str | None", + "description": "Issuer group.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "guarantor_name", + "type": "str | None", + "description": "Guarantor name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "guarantor_residence", + "type": "str | None", + "description": "Guarantor country of residence.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "covered_bond", + "type": "str | None", + "description": "Potentially own-usable covered bond flag.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "climate_factor", + "type": "float | None", + "description": "Climate factor.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "snapshot_date", + "type": "date | None", + "description": "The date of the eligible-assets snapshot.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "EcbEligibleAssets", + "openapi_extra": { + "model": "EcbEligibleAssets" + } + }, + "/econometrics/correlation_matrix": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the correlation matrix of an input dataset.\n\nThe correlation matrix shows how strongly the variables in the dataset move in\nrelation to one another. Scores range from -1 (perfect negative correlation) through\n0 (no correlation) to 1 (perfect positive correlation).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the correlation matrix of a dataset.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.correlation_matrix(data=stock_data)\nobb.econometrics.correlation_matrix(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "method", + "type": "str", + "description": "Correlation method: 'pearson' (standard), 'kendall' (Kendall Tau), or 'spearman' (rank correlation).", + "default": "pearson", + "optional": true + }, + { + "name": "min_periods", + "type": "int", + "description": "Minimum number of observations required per pair of columns to compute a correlation.", + "default": 1, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CorrelationMatrixData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "comp_to", + "type": "str", + "description": "The variable each correlation in the row is measured against.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/summary_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute descriptive summary statistics for each numeric column.\n\nReturns per-column count, mean, standard deviation, minimum, quartiles, maximum,\nskewness, and excess kurtosis - a quick overview of each variable's distribution.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.summary_statistics(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[SummaryStatisticsData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "column", + "type": "str", + "description": "Name of the column.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "Number of non-null observations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mean", + "type": "float", + "description": "Arithmetic mean.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "std", + "type": "float", + "description": "Sample standard deviation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "min", + "type": "float", + "description": "Minimum value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p25", + "type": "float", + "description": "25th percentile.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "median", + "type": "float", + "description": "Median (50th percentile).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p75", + "type": "float", + "description": "75th percentile.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max", + "type": "float", + "description": "Maximum value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "skew", + "type": "float", + "description": "Skewness of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kurtosis", + "type": "float", + "description": "Excess kurtosis of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/ols_regression": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Ordinary Least Squares (OLS) regression.\n\nOLS fits the best linear relationship between a dependent variable and one or more\nindependent variables. Returns the estimated coefficient table - one row per\nregressor, with standard errors, t-statistics, p-values, and confidence intervals.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Perform Ordinary Least Squares (OLS) regression.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.ols_regression(data=stock_data, y_column=\"close\", x_columns=[\"open\", \"high\", \"low\"])\nobb.econometrics.ols_regression(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator for the standard errors: 'nonrobust', or heteroskedasticity-robust 'HC0', 'HC1', 'HC2', or 'HC3'.", + "default": "nonrobust", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[OlsRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor ('const' is the intercept).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "Two-sided p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/ols_regression_summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform Ordinary Least Squares (OLS) regression and return the fit summary.\n\nReturns the model-level goodness-of-fit statistics - R-squared, F-statistic,\ninformation criteria, log-likelihood, and degrees of freedom - along with the full\nstatsmodels text summary.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.ols_regression_summary(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator for the standard errors: 'nonrobust', or heteroskedasticity-robust 'HC0', 'HC1', 'HC2', or 'HC3'.", + "default": "nonrobust", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OlsRegressionSummaryData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "r_squared", + "type": "float", + "description": "Coefficient of determination.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adjusted_r_squared", + "type": "float", + "description": "R-squared adjusted for the number of regressors.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "f_statistic", + "type": "float", + "description": "F-statistic of the overall regression.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "f_p_value", + "type": "float", + "description": "p-value of the F-statistic.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "aic", + "type": "float", + "description": "Akaike Information Criterion.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bic", + "type": "float", + "description": "Bayesian Information Criterion.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "log_likelihood", + "type": "float", + "description": "Log-likelihood of the fitted model.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "nobs", + "type": "int", + "description": "Number of observations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "df_model", + "type": "float", + "description": "Model degrees of freedom.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "df_residuals", + "type": "float", + "description": "Residual degrees of freedom.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "summary", + "type": "str", + "description": "Full statsmodels text summary.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/autocorrelation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Durbin-Watson test for autocorrelation in regression residuals.\n\nThe Durbin-Watson statistic ranges from 0 to 4. A value near 2 suggests no\nautocorrelation; values toward 0 indicate positive autocorrelation and values\ntoward 4 indicate negative autocorrelation.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AutocorrelationData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "durbin_watson", + "type": "float", + "description": "Durbin-Watson statistic (near 2 = no autocorrelation).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/residual_autocorrelation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Breusch-Godfrey LM test for residual autocorrelation.\n\nThe Breusch-Godfrey test detects autocorrelation in regression residuals up to a\nchosen number of lags. Significant statistics indicate the model has not captured\nsome of the data's serial dependence.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.residual_autocorrelation(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "lags", + "type": "int", + "description": "Number of lags to include in the test.", + "default": 1, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ResidualAutocorrelationData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "lm_statistic", + "type": "float", + "description": "Lagrange Multiplier test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lm_p_value", + "type": "float", + "description": "p-value of the LM statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "f_statistic", + "type": "float", + "description": "F-statistic of the auxiliary regression.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "f_p_value", + "type": "float", + "description": "p-value of the F-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/heteroskedasticity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Breusch-Pagan and White tests for heteroskedasticity.\n\nHeteroskedasticity - non-constant variance of the regression residuals - violates a\nkey OLS assumption and makes standard errors unreliable. The Breusch-Pagan test\ndetects linear forms; the White test additionally captures non-linear forms.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.heteroskedasticity(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "robust", + "type": "bool", + "description": "Use the robust (studentized Koenker) Breusch-Pagan variant, which does not assume normally distributed residuals.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "HeteroskedasticityData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "breusch_pagan_lm_statistic", + "type": "float", + "description": "Breusch-Pagan LM statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "breusch_pagan_lm_p_value", + "type": "float", + "description": "p-value of the Breusch-Pagan LM statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "breusch_pagan_f_statistic", + "type": "float", + "description": "Breusch-Pagan F statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "breusch_pagan_f_p_value", + "type": "float", + "description": "p-value of the Breusch-Pagan F statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "white_lm_statistic", + "type": "float", + "description": "White LM statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "white_lm_p_value", + "type": "float", + "description": "p-value of the White LM statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "white_f_statistic", + "type": "float", + "description": "White F statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "white_f_p_value", + "type": "float", + "description": "p-value of the White F statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/normality": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Jarque-Bera normality test on regression residuals.\n\nThe Jarque-Bera test checks whether OLS residuals are normally distributed by\ncomparing their skewness and kurtosis to those of a normal distribution.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.normality(y_column='close', x_columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NormalityData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "jarque_bera", + "type": "float", + "description": "Jarque-Bera test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "skew", + "type": "float", + "description": "Skewness of the residuals.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kurtosis", + "type": "float", + "description": "Kurtosis of the residuals.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/variance_inflation_factor": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the variance inflation factor (VIF) to detect multicollinearity.\n\nVIF quantifies how much the variance of an estimated coefficient is inflated by\ncollinearity with the other regressors. A VIF between 1 and 5 is generally\nacceptable; values above 5 indicate high collinearity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Calculate the variance inflation factor.\nstock_data = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').to_df()\nobb.econometrics.variance_inflation_factor(data=stock_data, columns=[\"open\", \"high\", \"low\", \"close\"])\nobb.econometrics.variance_inflation_factor(columns=['open', 'high', 'low'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "columns", + "type": "list[str]", + "description": "Columns to test for collinearity. If omitted, all numeric columns.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[VarianceInflationFactorData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the variable.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vif", + "type": "float", + "description": "Variance inflation factor (above 5 indicates high collinearity).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/unit_root": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Augmented Dickey-Fuller (ADF) unit root test.\n\nThe ADF test checks whether a series has a unit root - a sign of non-stationarity.\nRejecting the null hypothesis indicates the series is stationary.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.unit_root(column='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "column", + "type": "str", + "description": "Column to test for a unit root.", + "default": null, + "optional": false + }, + { + "name": "regression", + "type": "str", + "description": "Deterministic terms: 'c' constant, 'ct' constant and trend, 'ctt' constant, trend, and quadratic trend.", + "default": "c", + "optional": true + }, + { + "name": "maxlag", + "type": "int", + "description": "Maximum lag to include. If None, a data-dependent default is used.", + "default": null, + "optional": true + }, + { + "name": "autolag", + "type": "str", + "description": "Lag-selection method: 'AIC', 'BIC', or 't-stat'; None uses maxlag directly without selection.", + "default": "AIC", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UnitRootData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "adf_stat", + "type": "float", + "description": "Test statistic (more negative favours stationarity).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "MacKinnon p-value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "used_lag", + "type": "int", + "description": "Number of lags used.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "nobs", + "type": "int", + "description": "Number of observations used.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "ic_best", + "type": "float", + "description": "Maximised information criterion (None when autolag is disabled).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "critical_values", + "type": "dict", + "description": "Critical values at the 1%, 5%, and 10% levels.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/kpss": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the KPSS test for stationarity.\n\nThe KPSS null hypothesis is that the series IS stationary - the opposite of the ADF\ntest - so running both tests gives a more robust read on stationarity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.kpss(column='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "column", + "type": "str", + "description": "Column to test.", + "default": null, + "optional": false + }, + { + "name": "regression", + "type": "str", + "description": "Null hypothesis: 'c' level-stationary, 'ct' trend-stationary.", + "default": "c", + "optional": true + }, + { + "name": "nlags", + "type": "int | str", + "description": "Lags for the variance estimator: 'auto', 'legacy', or an explicit non-negative integer.", + "default": "auto", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "KpssData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "kpss_stat", + "type": "float", + "description": "Test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value_interpolated", + "type": "bool", + "description": "False when p_value is a clamped table boundary (the true p-value is more extreme than reported).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lags", + "type": "int", + "description": "Number of lags used in the test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "critical_values", + "type": "dict", + "description": "Critical values at the 10%, 5%, 2.5%, and 1% levels.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/cointegration": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Test pairs of time series for cointegration via the Engle-Granger two-step test.\n\nCointegration means two non-stationary series share a long-run equilibrium. The\nEngle-Granger test regresses one series on the other and checks the residuals for\nstationarity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.cointegration(columns=['open', 'close'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "columns", + "type": "list[str]", + "description": "Columns to test pairwise for cointegration.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CointegrationData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "pair", + "type": "str", + "description": "The tested column pair, formatted as 'x/y'.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "c", + "type": "float", + "description": "Constant of the long-run relationship.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "gamma", + "type": "float", + "description": "Slope of the long-run relationship.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "alpha", + "type": "float", + "description": "Error-correction speed of adjustment.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_stat", + "type": "float", + "description": "Dickey-Fuller statistic on the residuals.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the Dickey-Fuller statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/cointegration_johansen": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Johansen cointegration test on multiple time series.\n\nThe Johansen test detects cointegrating relationships among two or more series\nsimultaneously, reporting the number of cointegrating vectors via the trace and\nmaximum-eigenvalue statistics.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.cointegration_johansen(columns=['open', 'close'], data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "columns", + "type": "list[str]", + "description": "Columns (time series) to test jointly for cointegration.", + "default": null, + "optional": false + }, + { + "name": "deterministic_order", + "type": "int", + "description": "Deterministic trend: -1 none, 0 constant, 1 constant and trend.", + "default": 0, + "optional": true + }, + { + "name": "k_ar_diff", + "type": "int", + "description": "Number of lagged differences in the model.", + "default": 1, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CointegrationJohansenData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "rank", + "type": "int", + "description": "Cointegration rank hypothesis (r <= rank).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eigenvalue", + "type": "float", + "description": "Eigenvalue associated with the rank.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trace_statistic", + "type": "float", + "description": "Trace test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trace_crit_90", + "type": "float", + "description": "Trace critical value at the 90% level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trace_crit_95", + "type": "float", + "description": "Trace critical value at the 95% level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trace_crit_99", + "type": "float", + "description": "Trace critical value at the 99% level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max_eig_statistic", + "type": "float", + "description": "Maximum-eigenvalue test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max_eig_crit_90", + "type": "float", + "description": "Maximum-eigenvalue critical value at the 90% level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max_eig_crit_95", + "type": "float", + "description": "Maximum-eigenvalue critical value at the 95% level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max_eig_crit_99", + "type": "float", + "description": "Maximum-eigenvalue critical value at the 99% level.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/causality": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Perform the Granger causality test to assess whether X helps predict y.\n\nGranger causality tests whether past values of one series improve the forecast of\nanother. It is a predictive, not a structural, notion of causality.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Granger causality test with mock data.\nobb.econometrics.causality(y_column='close', x_column='open', lag=1, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Target column.", + "default": null, + "optional": false + }, + { + "name": "x_column", + "type": "str", + "description": "Candidate causal column.", + "default": null, + "optional": false + }, + { + "name": "lag", + "type": "int", + "description": "Number of lags to test.", + "default": 3, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CausalityData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "test", + "type": "str", + "description": "Name of the Granger sub-test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "statistic", + "type": "float", + "description": "Test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lag", + "type": "int", + "description": "Number of lags tested.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/garch": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fit a configurable volatility model from the GARCH family to a series.\n\nThe mean model, volatility process, lag orders, power, and innovation distribution\nare all configurable. The estimated conditional volatility series is returned; the\nfitted parameters and information criteria are attached to ``OBBject.extra``. Best\napplied to a return series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.garch(column='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "column", + "type": "str", + "description": "Column to model. Best applied to a return series.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Exogenous regressor columns for the mean model (used by the 'LS', 'ARX', and 'HARX' mean models).", + "default": null, + "optional": true + }, + { + "name": "mean", + "type": "str", + "description": "Mean model: 'Constant' (constant mean), 'Zero' (zero mean), 'LS' (least squares), 'AR'/'ARX' (autoregressive, 'ARX' adds exogenous regressors), 'HAR'/'HARX' (heterogeneous autoregressive).", + "default": "Constant", + "optional": true + }, + { + "name": "lags", + "type": "int", + "description": "Lag order of the 'AR', 'ARX', 'HAR', and 'HARX' mean models.", + "default": 0, + "optional": true + }, + { + "name": "vol", + "type": "str", + "description": "Volatility process: 'GARCH', 'ARCH', 'EGARCH' (exponential GARCH, captures leverage), 'FIGARCH' (fractionally integrated, long memory), 'APARCH' (asymmetric power ARCH), 'HARCH' (heterogeneous ARCH).", + "default": "GARCH", + "optional": true + }, + { + "name": "p", + "type": "int", + "description": "Order of the symmetric ARCH (innovation) term.", + "default": 1, + "optional": true + }, + { + "name": "o", + "type": "int", + "description": "Order of the asymmetric (leverage) term.", + "default": 0, + "optional": true + }, + { + "name": "q", + "type": "int", + "description": "Order of the lagged volatility (GARCH) term.", + "default": 1, + "optional": true + }, + { + "name": "power", + "type": "float", + "description": "Power applied to the conditional volatility (2.0 is standard GARCH; other values give power-GARCH and APARCH variants).", + "default": 2.0, + "optional": true + }, + { + "name": "distribution", + "type": "str", + "description": "Distribution of the model innovations: 'normal' (Gaussian), 't' (Student's t, fat tails), 'skewt' (skewed Student's t), or 'ged' (generalized error distribution).", + "default": "normal", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[GarchData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | int | str", + "description": "Observation date (integer position when the input has no date).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conditional_volatility", + "type": "float", + "description": "Estimated conditional volatility at the observation.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/panel_random_effects": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate a one-way Random Effects model for panel data.\n\nThe Random Effects model treats entity-specific deviations as random draws,\ncapturing variation across entities while pooling information for efficient\nestimation. Requires at least three observations.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_random_effects(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input panel dataset, indexed by entity and time.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator: 'unadjusted' (homoskedastic) or 'robust' (heteroskedasticity-robust standard errors).", + "default": "unadjusted", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PanelRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/panel_between": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate a Between regression on panel data.\n\nThe Between estimator regresses the entity-level means, summarising the long-run\ncross-sectional relationship between the regressors and the target.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_between(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input panel dataset, indexed by entity and time.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator: 'unadjusted' (homoskedastic) or 'robust' (heteroskedasticity-robust standard errors).", + "default": "unadjusted", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PanelRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/panel_pooled": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate a Pooled OLS regression on panel data.\n\nThe Pooled estimator treats the panel as one large cross-section, assuming the\nregressors have a uniform effect across all entities and time periods.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_pooled(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input panel dataset, indexed by entity and time.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator: 'unadjusted' (homoskedastic) or 'robust' (heteroskedasticity-robust standard errors).", + "default": "unadjusted", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PanelRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/panel_fixed": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate a Fixed Effects regression on panel data.\n\nThe Fixed Effects estimator controls for entity- and/or time-specific effects,\nisolating the effect of the regressors from unobserved heterogeneity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_fixed(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input panel dataset, indexed by entity and time.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator: 'unadjusted' (homoskedastic) or 'robust' (heteroskedasticity-robust standard errors).", + "default": "unadjusted", + "optional": true + }, + { + "name": "entity_effects", + "type": "bool", + "description": "Include entity-specific fixed effects.", + "default": true, + "optional": true + }, + { + "name": "time_effects", + "type": "bool", + "description": "Include time-specific fixed effects.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PanelRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/panel_first_difference": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate a First-Difference regression on panel data.\n\nDifferencing consecutive observations removes time-invariant entity effects, so the\nestimator measures how changes in the regressors relate to changes in the target.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_first_difference(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input panel dataset, indexed by entity and time.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator: 'unadjusted' (homoskedastic) or 'robust' (heteroskedasticity-robust standard errors).", + "default": "unadjusted", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PanelRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/econometrics/panel_fmac": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate a Fama-MacBeth regression on panel data.\n\nThe Fama-MacBeth procedure runs a cross-sectional regression each period and\naverages the coefficients over time - widely used to estimate risk premia.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.econometrics.panel_fmac(y_column='portfolio_value', x_columns=['risk_free_rate'], data=[{'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 0, 'portfolio_value': 100000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_1', 'time': 1, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 0, 'portfolio_value': 150000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_2', 'time': 1, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 0, 'portfolio_value': 133333.33, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_3', 'time': 1, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 0, 'portfolio_value': 125000.0, 'risk_free_rate': 0.03}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_4', 'time': 1, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 0, 'portfolio_value': 120000.0, 'risk_free_rate': 0.02}, {'is_multiindex': True, 'multiindex_names': \"['asset_manager', 'time']\", 'asset_manager': 'asset_manager_5', 'time': 1, 'portfolio_value': 116666.67, 'risk_free_rate': 0.02}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input panel dataset, indexed by entity and time.", + "default": null, + "optional": false + }, + { + "name": "y_column", + "type": "str", + "description": "Name of the dependent (target) column.", + "default": null, + "optional": false + }, + { + "name": "x_columns", + "type": "list[str]", + "description": "Names of the independent (exogenous) columns.", + "default": null, + "optional": false + }, + { + "name": "cov_type", + "type": "str", + "description": "Covariance estimator: 'unadjusted' (homoskedastic) or 'robust' (heteroskedasticity-robust standard errors).", + "default": "unadjusted", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PanelRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variable", + "type": "str", + "description": "Name of the regressor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Estimated coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "standard_error", + "type": "float", + "description": "Standard error of the coefficient.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the null hypothesis that the coefficient is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "p-value of the t-statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_lower", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "conf_int_upper", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/eia/rss_feed": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Articles, releases, testimony, and fuel-price updates from EIA's RSS feeds.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "feed", + "type": "str", + "description": "", + "default": "today_in_energy", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA RSS Feeds", + "description": "Articles, releases, testimony, and fuel-price updates from the U.S. Energy Information Administration RSS feeds.", + "category": "EIA", + "subCategory": "News & Feeds", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_rss_feeds_us_eia_obb", + "gridData": { + "w": 40, + "h": 20 + }, + "params": [ + { + "paramName": "feed", + "label": "Feed", + "type": "tabs", + "value": "today_in_energy", + "description": "The EIA RSS feed to display.", + "show": true, + "options": [ + { + "label": "Today in Energy", + "value": "today_in_energy" + }, + { + "label": "What's New", + "value": "whats_new" + }, + { + "label": "Press Releases", + "value": "press_releases" + }, + { + "label": "Congressional Testimony", + "value": "congressional_testimony" + }, + { + "label": "Presentations", + "value": "presentations" + }, + { + "label": "Gasoline & Diesel Fuel Update", + "value": "gasoline_diesel" + }, + { + "label": "Heating Oil & Propane Update", + "value": "heating_oil_propane" + } + ] + }, + { + "paramName": "theme", + "show": false + } + ], + "refetchInterval": 900000, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/electricity_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "U.S. electric power statistics: net generation, consumption, retail sales, revenue and average retail price, fuel receipts, costs and quality, and plant-level operations - by state, sector, and fuel, monthly through annual.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Electricity Browser", + "description": "U.S. electric power statistics: net generation, consumption, retail sales, revenue and average retail price, fuel receipts, costs and quality, and plant-level operations - by state, sector, and fuel, monthly through annual.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_electricity_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/coal_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "U.S. coal statistics: production, consumption and quality, prices by rank, recoverable reserves and mine capacity, exports and imports, and mine- and plant-level shipments - by state, region, mine type, and coal rank.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Coal Browser", + "description": "U.S. coal statistics: production, consumption and quality, prices by rank, recoverable reserves and mine capacity, exports and imports, and mine- and plant-level shipments - by state, region, mine type, and coal rank.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_coal_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/total_energy_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The Monthly Energy Review: recent and historical U.S. energy statistics, including total energy production, consumption, stocks, and trade; energy prices; overviews of petroleum, natural gas, coal, electricity, nuclear energy, renewable energy, and carbon dioxide emissions; and energy unit conversion values.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Total Energy (MER) Browser", + "description": "The Monthly Energy Review: recent and historical U.S. energy statistics, including total energy production, consumption, stocks, and trade; energy prices; overviews of petroleum, natural gas, coal, electricity, nuclear energy, renewable energy, and carbon dioxide emissions; and energy unit conversion values.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_total_energy_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/steo_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The Short-Term Energy Outlook: EIA's monthly 18-month forecast of energy supply, demand, prices, and inventories - crude oil and liquid fuels, natural gas, electricity, coal, renewables, and energy-related carbon dioxide emissions - for the United States and the world.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Short-Term Energy Outlook Browser", + "description": "The Short-Term Energy Outlook: EIA's monthly 18-month forecast of energy supply, demand, prices, and inventories - crude oil and liquid fuels, natural gas, electricity, coal, renewables, and energy-related carbon dioxide emissions - for the United States and the world.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_steo_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/aeo_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The Annual Energy Outlook: EIA's long-term projections of U.S. energy production, consumption, trade, prices, and emissions through 2050, in the Reference case and alternative side cases covering economic growth, oil prices, and technology.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Annual Energy Outlook Browser", + "description": "The Annual Energy Outlook: EIA's long-term projections of U.S. energy production, consumption, trade, prices, and emissions through 2050, in the Reference case and alternative side cases covering economic growth, oil prices, and technology.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_aeo_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/international_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "International energy statistics for more than 200 countries and regions: production, consumption, imports, exports, reserves, and carbon dioxide emissions for petroleum and other liquids, natural gas, coal, electricity, nuclear, and renewables.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA International Browser", + "description": "International energy statistics for more than 200 countries and regions: production, consumption, imports, exports, reserves, and carbon dioxide emissions for petroleum and other liquids, natural gas, coal, electricity, nuclear, and renewables.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_international_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/petroleum_imports_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company-level U.S. crude oil and petroleum product imports (Form EIA-814): volumes by country of origin, port and PAD District of entry, processing refinery and company, crude grade, and API gravity - monthly and annual.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Petroleum Imports Browser", + "description": "Company-level U.S. crude oil and petroleum product imports (Form EIA-814): volumes by country of origin, port and PAD District of entry, processing refinery and company, crude grade, and API gravity - monthly and annual.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_petroleum_imports_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/natural_gas_query_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "The Natural Gas Annual Respondent Query System (Form EIA-176): company- and state-level natural gas volumes and prices, covering production, deliveries by consuming sector, underground and LNG storage, and supplemental supplies.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Natural Gas Annual Respondent Query System Browser", + "description": "The Natural Gas Annual Respondent Query System (Form EIA-176): company- and state-level natural gas volumes and prices, covering production, deliveries by consuming sector, underground and LNG storage, and supplemental supplies.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_natural_gas_query_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/states_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "State Energy Profiles: energy production, consumption, prices, expenditures, and cross-state rankings for coal, natural gas, petroleum, electricity, nuclear, and renewables, for every U.S. state and territory.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA State Energy Profiles Browser", + "description": "State Energy Profiles: energy production, consumption, prices, expenditures, and cross-state rankings for coal, natural gas, petroleum, electricity, nuclear, and renewables, for every U.S. state and territory.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_states_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/maps_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "EIA's oil and natural gas maps: shale plays and sedimentary basins, pipelines and infrastructure, refineries, and production regions - as PDF and image maps.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Oil & Natural Gas Maps Browser", + "description": "EIA's oil and natural gas maps: shale plays and sedimentary basins, pipelines and infrastructure, refineries, and production regions - as PDF and image maps.", + "category": "EIA", + "subCategory": "Data Browsers", + "source": [ + "EIA" + ], + "type": "iframe", + "widgetId": "eia_maps_browser_us_eia_obb", + "gridData": { + "w": 40, + "h": 22 + }, + "params": [ + { + "paramName": "theme", + "show": false + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false, + "staleTime": 1000, + "raw": true, + "storage": { + "mcpUrl": "http://127.0.0.1:6900/api/v1/eia/eia_mcp" + } + } + } + }, + "/eia/datasets": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Catalog of EIA APIv2 datasets served by this extension.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List every EIA dataset served by this extension.\nobb.eia.datasets()\n# List the coal datasets with their filters and data columns.\nobb.eia.datasets(group='coal')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "group", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Dataset Catalog", + "category": "EIA", + "subCategory": "Reference", + "source": [ + "EIA" + ] + }, + "model": "" + } + }, + "/eia/facet_options": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the valid values for one filter (facet) of an EIA dataset.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List the spot price series available from the petroleum group.\nobb.eia.facet_options(group='petroleum', dataset='spot_prices', facet='series')\n# List the balancing authorities of the hourly grid monitor.\nobb.eia.facet_options(group='electricity_grid', dataset='demand', facet='respondent')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "group", + "type": "str", + "description": "", + "default": null, + "optional": false + }, + { + "name": "facet", + "type": "str", + "description": "", + "default": null, + "optional": false + }, + { + "name": "dataset", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "EIA Filter Values", + "category": "EIA", + "subCategory": "Reference", + "source": [ + "EIA" + ] + }, + "model": "" + } + }, + "/eia/coal/aggregate_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Aggregate Production. Coal state aggregated data by mine type, includes production, productivity, labor hours, employees, and coal rank. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.aggregate_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_employees (number of employees); labor_hours (hours); number_of_mines (number of mines); production (short tons); productivity (short tons per labor hour). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_employees", + "labor_hours", + "number_of_mines", + "production", + "productivity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None | list[str | None]", + "description": "Mine Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "refuse", + "surface", + "underground" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "appalachia_total", + "arizona", + "arkansas", + "colorado", + "east_north_central", + "east_south_central", + "east_total", + "east_of_mississippi_river", + "illinois", + "illinois_basin", + "indiana", + "interior_region_total", + "kansas", + "kentucky", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "middle_atlantic", + "midwest_total", + "mississippi", + "missouri", + "montana", + "mountain", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "other_interior", + "other_western", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "powder_river_basin", + "south_atlantic", + "south_total", + "tennessee", + "texas", + "us_total", + "uinta_basin", + "utah", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_total", + "west_virginia", + "west_virginia_northern", + "west_virginia_southern", + "west_of_mississippi_river", + "western_region_total", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalAggregateProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None", + "description": "Mine Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type_name", + "type": "str | None", + "description": "Mine Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_employees", + "type": "float | None", + "description": "Average employees (number of employees). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "labor_hours", + "type": "float | None", + "description": "Labor hours (hours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_mines", + "type": "float | None", + "description": "Number of mines (number of mines). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "production", + "type": "float | None", + "description": "Production (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "productivity", + "type": "float | None", + "description": "Productivity (short tons per labor hour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalAggregateProduction", + "openapi_extra": { + "widget_config": { + "name": "Aggregate Production", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalAggregateProduction" + } + }, + "/eia/coal/by_mine_by_plant": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "By Mine, By Plant. Coal shipments from mine- to plant-level data, including price, quantity, quality, and rank. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.by_mine_by_plant(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "heat_content", + "price", + "quantity", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Type filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous", + "synfuel_coal", + "waste_coal" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_supplier", + "type": "str | None | list[str | None]", + "description": "Coal Supplier filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None | list[str | None]", + "description": "Mine filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None | list[str | None]", + "description": "Mine State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "colorado", + "illinois", + "indiana", + "kansas", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "mississippi", + "missouri", + "montana", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "tennessee", + "texas", + "utah", + "virginia", + "west_virginia_northern", + "west_virginia_southern", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None | list[str | None]", + "description": "Plant filter. Accepts a comma-separated list of values. There are 475 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant_state", + "type": "str | None | list[str | None]", + "description": "Plant State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "florida", + "georgia", + "hawaii", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "utah", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalByMineByPlant", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_supplier", + "type": "str | None", + "description": "Coal Supplier code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_supplier_name", + "type": "str | None", + "description": "Coal Supplier name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None", + "description": "Mine code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_name", + "type": "str | None", + "description": "Mine name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None", + "description": "Mine State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state_name", + "type": "str | None", + "description": "Mine State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None", + "description": "Plant code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_name", + "type": "str | None", + "description": "Plant name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_state", + "type": "str | None", + "description": "Plant State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_state_name", + "type": "str | None", + "description": "Plant State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (Btu per pound). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (average dollars per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalByMineByPlant", + "openapi_extra": { + "widget_config": { + "name": "By Mine, By Plant", + "category": "EIA", + "subCategory": "Coal Shipments", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalByMineByPlant" + } + }, + "/eia/coal/consumption_and_quality": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Consumption and Quality. Coal consumption and quality data by state and sector, including price, reciepts, heat content, sulfur content, ash content, and stocks. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.consumption_and_quality(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (average ash percent by weight); consumption (short tons); heat_content (average sulfur percent by weight); price (dollars per short ton); receipts (short tons); stocks (short tons); sulfur_content (average sulfur percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "consumption", + "heat_content", + "price", + "receipts", + "stocks", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "Sector filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "coke_plants", + "commercial_and_institutional", + "electric_power", + "electric_utility", + "ipp_chp", + "ipp_non_chp", + "independent_power_producers", + "other_industrial" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "U.S. Total, States, and Census Regions. filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "east_north_central", + "east_south_central", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "middle_atlantic", + "minnesota", + "mississippi", + "missouri", + "montana", + "mountain", + "nebraska", + "nevada", + "new_england", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pacific", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "puerto_rico", + "rhode_island", + "south_atlantic", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "us_total", + "utah", + "vermont", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalConsumptionAndQuality", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "sector", + "type": "str | None", + "description": "Sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "Sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "U.S. Total, States, and Census Regions. code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "U.S. Total, States, and Census Regions. name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (average ash percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption", + "type": "float | None", + "description": "Consumption (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (average sulfur percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (dollars per short ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receipts", + "type": "float | None", + "description": "Receipts (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stocks", + "type": "float | None", + "description": "Stocks (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (average sulfur percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalConsumptionAndQuality", + "openapi_extra": { + "widget_config": { + "name": "Consumption and Quality", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalConsumptionAndQuality" + } + }, + "/eia/coal/exports_imports_quantity_price": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Exports/Imports Quantity/Price. Coal import/export data, including price, quantity, country, rank, and customs district. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.exports_imports_quantity_price(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: price (dollars per short ton); quantity (short tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "price", + "quantity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "coke", + "metallurgical", + "steam_coal" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "Country filter. Accepts a comma-separated list of values. There are 141 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "customs_district", + "type": "str | None | list[str | None]", + "description": "Customs District filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "anchorage_ak", + "baltimore_md", + "boston_ma", + "buffalo_ny", + "charleston_sc", + "charlotte_nc", + "chicago_il", + "cleveland_oh", + "columbia_snake_or", + "dallas_fort_worth_tx", + "detroit_mi", + "duluth_mn", + "el_paso_tx", + "great_falls_mt", + "honolulu_hi", + "houston_galveston_tx", + "laredo_tx", + "los_angeles_ca", + "miami_fl", + "milwaukee_wi", + "minneapolis_mn", + "mobile_al", + "new_orleans_la", + "new_york_city_ny", + "nogales_az", + "norfolk_va", + "ogdensburg_ny", + "other_ports", + "pembina_nd", + "philadelphia_pa", + "port_arthur_tx", + "portland_me", + "portland_or", + "providence_ri", + "san_diego_ca", + "san_francisco_ca", + "san_juan_pr", + "savannah_ga", + "seattle_wa", + "st_albans_vt", + "tampa_fl", + "total", + "virgin_islands_of_the_united_states", + "wilmington_nc" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "export_import_type", + "type": "str | None | list[str | None]", + "description": "Export\\Import Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "exports", + "imports" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalExportsImportsQuantityPrice", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_name", + "type": "str | None", + "description": "Country name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customs_district", + "type": "str | None", + "description": "Customs District code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customs_district_name", + "type": "str | None", + "description": "Customs District name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "export_import_type", + "type": "str | None", + "description": "Export\\Import Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "export_import_type_name", + "type": "str | None", + "description": "Export\\Import Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (dollars per short ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalExportsImportsQuantityPrice", + "openapi_extra": { + "widget_config": { + "name": "Exports\\Imports Quantity\\Price", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalExportsImportsQuantityPrice" + } + }, + "/eia/coal/market_sales_price": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Market Sales Price. Coal market sales prices and amounts by mine types for regions and states (unless withheld for pricing protections). Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.market_sales_price(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: price (dollars per short ton); sales (short tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "price", + "sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "market_type", + "type": "str | None | list[str | None]", + "description": "Market Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "captive", + "open_market", + "total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "appalachia_total", + "arizona", + "arkansas", + "colorado", + "east_north_central", + "east_south_central", + "east_total", + "east_of_mississippi_river", + "illinois", + "illinois_basin", + "indiana", + "interior_region_total", + "kansas", + "kentucky", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "middle_atlantic", + "midwest_total", + "mississippi", + "missouri", + "montana", + "mountain", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "other_interior", + "other_western", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "powder_river_basin", + "south_atlantic", + "south_total", + "tennessee", + "texas", + "us_total", + "uinta_basin", + "utah", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_total", + "west_virginia", + "west_virginia_northern", + "west_virginia_southern", + "west_of_mississippi_river", + "western_region_total", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalMarketSalesPrice", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "market_type", + "type": "str | None", + "description": "Market Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_type_name", + "type": "str | None", + "description": "Market Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (dollars per short ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales", + "type": "float | None", + "description": "Sales (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalMarketSalesPrice", + "openapi_extra": { + "widget_config": { + "name": "Market Sales Price", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalMarketSalesPrice" + } + }, + "/eia/coal/mine_aggregates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Mine Aggregates. Coal shipments aggregated at mine-level data, including price, quantity, quality, and rank. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.mine_aggregates(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "heat_content", + "price", + "quantity", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None | list[str | None]", + "description": "Mine filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None | list[str | None]", + "description": "Mine State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "colorado", + "illinois", + "indiana", + "kansas", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "mississippi", + "missouri", + "montana", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "tennessee", + "texas", + "utah", + "virginia", + "west_virginia_northern", + "west_virginia_southern", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalMineAggregates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None", + "description": "Mine code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_name", + "type": "str | None", + "description": "Mine name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None", + "description": "Mine State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state_name", + "type": "str | None", + "description": "Mine State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (Btu per pound). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (average dollars per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalMineAggregates", + "openapi_extra": { + "widget_config": { + "name": "Mine Aggregates", + "category": "EIA", + "subCategory": "Coal Shipments", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalMineAggregates" + } + }, + "/eia/coal/mine_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Mine Production. Coal mine-level data, including production, region, state, county, rank, status, type, name and description. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.mine_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_employees (number of employees); labor_hours (hours); latitude; longitude; operating_company; operating_company_address; production (short tons); refuse_flag. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_employees", + "labor_hours", + "latitude", + "longitude", + "operating_company", + "operating_company_address", + "production", + "refuse_flag" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "census_region", + "type": "str | None | list[str | None]", + "description": "Census Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_north_central", + "east_south_central", + "middle_atlantic", + "mountain", + "pacific_contiguous", + "pacific_noncontiguous", + "south_atlantic", + "west_north_central", + "west_south_central" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "anthracite", + "bituminous", + "lignite", + "preparation_plant", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None | list[str | None]", + "description": "Mine filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_county", + "type": "str | None | list[str | None]", + "description": "Mine County filter. Accepts a comma-separated list of values. There are 107 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "midwest", + "south", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_status", + "type": "str | None | list[str | None]", + "description": "Mine Status filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "active", + "active_men_not_working_not_producing", + "active_men_working_not_producing", + "mine_closed_by_msha", + "new_under_construction", + "permanently_abandoned", + "temporarily_closed" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None | list[str | None]", + "description": "Mine Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "refuse", + "surface", + "underground" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mississippi_region", + "type": "str | None | list[str | None]", + "description": "Mississippi Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_of_mississippi_river", + "west_of_mississippi_river" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "colorado", + "illinois", + "indiana", + "kansas", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "mississippi", + "missouri", + "montana", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "tennessee", + "texas", + "utah", + "virginia", + "washington", + "west_virginia_northern", + "west_virginia_southern", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "supply_region", + "type": "str | None | list[str | None]", + "description": "Supply Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "illinois_basin", + "other_interior", + "other_western", + "powder_river_basin", + "uinta_basin" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalMineProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "census_region", + "type": "str | None", + "description": "Census Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "census_region_name", + "type": "str | None", + "description": "Census Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None", + "description": "Mine code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_name", + "type": "str | None", + "description": "Mine name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_county", + "type": "str | None", + "description": "Mine County code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_county_name", + "type": "str | None", + "description": "Mine County name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_status", + "type": "str | None", + "description": "Mine Status code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_status_name", + "type": "str | None", + "description": "Mine Status name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None", + "description": "Mine Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type_name", + "type": "str | None", + "description": "Mine Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mississippi_region", + "type": "str | None", + "description": "Mississippi Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mississippi_region_name", + "type": "str | None", + "description": "Mississippi Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "supply_region", + "type": "str | None", + "description": "Supply Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "supply_region_name", + "type": "str | None", + "description": "Supply Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_employees", + "type": "float | None", + "description": "Average employees (number of employees). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "labor_hours", + "type": "float | None", + "description": "Labor hours (hours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "Latitude. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "Longitude. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_company", + "type": "str | None", + "description": "Operating company", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_company_address", + "type": "str | None", + "description": "Operating company address", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "production", + "type": "float | None", + "description": "Production (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "refuse_flag", + "type": "str | None", + "description": "Refuse flag", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalMineProduction", + "openapi_extra": { + "widget_config": { + "name": "Mine Production", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalMineProduction" + } + }, + "/eia/coal/mine_state_aggregates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Mine State Aggregates. Coal shipments aggregated at state-level data, including price, quantity, quality, and rank. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.mine_state_aggregates(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "heat_content", + "price", + "quantity", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None | list[str | None]", + "description": "Mine State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "appalachia_total", + "arizona", + "arkansas", + "colorado", + "east_north_central", + "east_south_central", + "illinois", + "illinois_basin", + "indiana", + "interior_region_total", + "kansas", + "kentucky", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "middle_atlantic", + "mississippi", + "missouri", + "montana", + "mountain", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "other_interior", + "other_western", + "overseas", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "powder_river_basin", + "south_atlantic", + "tennessee", + "texas", + "us_total", + "uinta_basin", + "utah", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_virginia", + "west_virginia_northern", + "west_virginia_southern", + "western_region_total", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalMineStateAggregates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None", + "description": "Mine State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state_name", + "type": "str | None", + "description": "Mine State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (Btu per pound). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (average dollars per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalMineStateAggregates", + "openapi_extra": { + "widget_config": { + "name": "Mine State Aggregates", + "category": "EIA", + "subCategory": "Coal Shipments", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalMineStateAggregates" + } + }, + "/eia/coal/plant_aggregates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Plant Aggregates. Coal reciepts aggregated to plant-level data, including price, quantity, quality, and rank. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.plant_aggregates(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "heat_content", + "price", + "quantity", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None | list[str | None]", + "description": "Plant filter. Accepts a comma-separated list of values. There are 530 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "Plant State\\Region. filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "colorado", + "illinois", + "indiana", + "kansas", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "mississippi", + "missouri", + "montana", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "overseas", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "tennessee", + "texas", + "utah", + "virginia", + "washington", + "west_virginia_northern", + "west_virginia_southern", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalPlantAggregates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None", + "description": "Plant code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_name", + "type": "str | None", + "description": "Plant name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "Plant State\\Region. code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "Plant State\\Region. name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (Btu per pound). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (average dollars per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalPlantAggregates", + "openapi_extra": { + "widget_config": { + "name": "Plant Aggregates", + "category": "EIA", + "subCategory": "Coal Shipments", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalPlantAggregates" + } + }, + "/eia/coal/plant_state_aggregates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Plant State Aggregates. Coal reciepts aggregated at state-level data, including price, quantity, quality, and rank. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.plant_state_aggregates(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "heat_content", + "price", + "quantity", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant_state", + "type": "str | None | list[str | None]", + "description": "Plant State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "east_north_central", + "east_south_central", + "florida", + "georgia", + "hawaii", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "middle_atlantic", + "minnesota", + "mississippi", + "missouri", + "montana", + "mountain", + "nebraska", + "nevada", + "new_england", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "rhode_island", + "south_atlantic", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "us_total", + "utah", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalPlantStateAggregates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_state", + "type": "str | None", + "description": "Plant State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_state_name", + "type": "str | None", + "description": "Plant State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (Btu per pound). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (average dollars per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalPlantStateAggregates", + "openapi_extra": { + "widget_config": { + "name": "Plant State Aggregates", + "category": "EIA", + "subCategory": "Coal Shipments", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalPlantStateAggregates" + } + }, + "/eia/coal/price_by_rank": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price by Rank. Coal prices by rank data for region and state. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.price_by_rank(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "appalachia_total", + "arizona", + "arkansas", + "colorado", + "east_north_central", + "east_south_central", + "east_total", + "east_of_mississippi_river", + "illinois", + "illinois_basin", + "indiana", + "interior_region_total", + "kansas", + "kentucky", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "middle_atlantic", + "midwest_total", + "mississippi", + "missouri", + "montana", + "mountain", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "other_interior", + "other_western", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "powder_river_basin", + "south_atlantic", + "south_total", + "tennessee", + "texas", + "us_total", + "uinta_basin", + "utah", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_total", + "west_virginia", + "west_virginia_northern", + "west_virginia_southern", + "west_of_mississippi_river", + "western_region_total", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalPriceByRank", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (dollars per short ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalPriceByRank", + "openapi_extra": { + "widget_config": { + "name": "Price by Rank", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalPriceByRank" + } + }, + "/eia/coal/receipts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Receipts. Coal shipment detailed by reciepient data, including transportation type, supplier, mine, coal basin, county, state, rank, contract type, price, quantity, and quality. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.receipts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'annual'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content (percent by weight); heat_content (Btu per pound); price (average dollars per ton); quantity (tons); sulfur_content (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "heat_content", + "price", + "quantity", + "sulfur_content" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank", + "type": "str | None | list[str | None]", + "description": "Coal Rank filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "anthracite", + "bituminous", + "lignite", + "subbituminous" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "coal_supplier", + "type": "str | None | list[str | None]", + "description": "Coal Supplier filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "contract_type", + "type": "str | None | list[str | None]", + "description": "Contract Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "contract_purchase", + "new_contract", + "none", + "spot_market_purchase" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None | list[str | None]", + "description": "Mine filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_basin", + "type": "str | None | list[str | None]", + "description": "Mine Basin filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "illinois_basin", + "other_interior", + "other_western", + "powder_river_basin", + "uinta_basin" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_county", + "type": "str | None | list[str | None]", + "description": "Mine County filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "10", + "101", + "107", + "109", + "115", + "119", + "127", + "129", + "133", + "147", + "149", + "159", + "175", + "177", + "189", + "203", + "225", + "233", + "235", + "237", + "25", + "3", + "33", + "39", + "47", + "49", + "53", + "61", + "63", + "67", + "7", + "71", + "77", + "79", + "81", + "85", + "9", + "91", + "95", + "97", + "99", + "anderson", + "atascosa", + "bourbon", + "campbell", + "choctaw", + "clay", + "columbiana", + "coshocton", + "craig", + "crawford", + "cullman", + "daviess", + "dickenson", + "douglas", + "emery", + "fayette", + "freestone", + "gallatin", + "jefferson", + "lawrence", + "lee", + "leon", + "limestone", + "lincoln", + "marion", + "mclean", + "meigs", + "montgomery", + "natchitoches", + "navajo", + "noble", + "none", + "okmulgee", + "oliver", + "perry", + "richland", + "rio_blanco", + "robertson", + "rogers", + "rusk", + "saline", + "san_juan", + "shelby", + "stark", + "sullivan", + "tazewell", + "titus", + "tuscaloosa", + "tuscarawas", + "vermilion", + "vigo", + "vinton", + "warrick", + "white", + "williamson", + "wise", + "yukon_koyukuk" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None | list[str | None]", + "description": "Mine State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "colorado", + "illinois", + "indiana", + "kansas", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "mississippi", + "missouri", + "montana", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "tennessee", + "texas", + "utah", + "virginia", + "west_virginia_northern", + "west_virginia_southern", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None | list[str | None]", + "description": "Mine Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "surface", + "underground" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None | list[str | None]", + "description": "Plant filter. Accepts a comma-separated list of values. There are 471 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant_state", + "type": "str | None | list[str | None]", + "description": "Plant State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "florida", + "georgia", + "hawaii", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "utah", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "transportation_mode", + "type": "str | None | list[str | None]", + "description": "Transportation Mode filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "great_lakes", + "none", + "pipeline", + "rail", + "river", + "tidewater_piers", + "tramway_conveyor", + "truck", + "water" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalReceipts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "coal_rank", + "type": "str | None", + "description": "Coal Rank code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_rank_name", + "type": "str | None", + "description": "Coal Rank name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_supplier", + "type": "str | None", + "description": "Coal Supplier code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coal_supplier_name", + "type": "str | None", + "description": "Coal Supplier name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "contract_type", + "type": "str | None", + "description": "Contract Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "contract_type_name", + "type": "str | None", + "description": "Contract Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine", + "type": "str | None", + "description": "Mine code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_name", + "type": "str | None", + "description": "Mine name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_basin", + "type": "str | None", + "description": "Mine Basin code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_basin_name", + "type": "str | None", + "description": "Mine Basin name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_county", + "type": "str | None", + "description": "Mine County code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_county_name", + "type": "str | None", + "description": "Mine County name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state", + "type": "str | None", + "description": "Mine State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_state_name", + "type": "str | None", + "description": "Mine State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None", + "description": "Mine Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type_name", + "type": "str | None", + "description": "Mine Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None", + "description": "Plant code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_name", + "type": "str | None", + "description": "Plant name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_state", + "type": "str | None", + "description": "Plant State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_state_name", + "type": "str | None", + "description": "Plant State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transportation_mode", + "type": "str | None", + "description": "Transportation Mode code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transportation_mode_name", + "type": "str | None", + "description": "Transportation Mode name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Ash content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Heat content (Btu per pound). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price (average dollars per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Sulfur content (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalReceipts", + "openapi_extra": { + "widget_config": { + "name": "Receipts", + "category": "EIA", + "subCategory": "Coal Shipments", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalReceipts" + } + }, + "/eia/coal/reserves_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Reserves Capacity. Coal capacity data, including productive capacity, stocks, and recoverable reserves by state, region and mine type. Source: EIA Form 7A and MSHA Form 7000-2. Interactive browser: https://www.eia.gov/coal/data/browser/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.coal.reserves_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: producer_distributor_stocks (short tons); productive_capacity (short tons); recoverable_reserves (short tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "producer_distributor_stocks", + "productive_capacity", + "recoverable_reserves" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mine_type", + "type": "str | None | list[str | None]", + "description": "Mine Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "surface", + "total", + "underground" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None | list[str | None]", + "description": "State\\Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "appalachia_central", + "appalachia_northern", + "appalachia_southern", + "appalachia_total", + "arizona", + "arkansas", + "colorado", + "east_north_central", + "east_south_central", + "east_total", + "east_of_mississippi_river", + "illinois", + "illinois_basin", + "indiana", + "interior_region_total", + "kansas", + "kentucky", + "kentucky_east", + "kentucky_west", + "louisiana", + "maryland", + "middle_atlantic", + "midwest_total", + "mississippi", + "missouri", + "montana", + "mountain", + "new_mexico", + "north_dakota", + "ohio", + "oklahoma", + "other_interior", + "other_western", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "pennsylvania_anthracite", + "pennsylvania_bituminous", + "powder_river_basin", + "south_atlantic", + "south_total", + "tennessee", + "texas", + "us_total", + "uinta_basin", + "utah", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_total", + "west_virginia", + "west_virginia_northern", + "west_virginia_southern", + "west_of_mississippi_river", + "western_region_total", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCoalReservesCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "mine_type", + "type": "str | None", + "description": "Mine Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mine_type_name", + "type": "str | None", + "description": "Mine Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region", + "type": "str | None", + "description": "State\\Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_region_name", + "type": "str | None", + "description": "State\\Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_distributor_stocks", + "type": "float | None", + "description": "Producer distributor stocks (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "productive_capacity", + "type": "float | None", + "description": "Productive capacity (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recoverable_reserves", + "type": "float | None", + "description": "Recoverable reserves (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCoalReservesCapacity", + "openapi_extra": { + "widget_config": { + "name": "Reserves Capacity", + "category": "EIA", + "subCategory": "Coal", + "source": [ + "EIA" + ] + }, + "model": "EiaCoalReservesCapacity" + } + }, + "/eia/petroleum/consumption_sales/adjusted_distillate_fuel_oil_and_kerosene_sales_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Adjusted Distillate Fuel Oil and Kerosene Sales by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.adjusted_distillate_fuel_oil_and_kerosene_sales_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "adj_sales_deliveries_transportation_total", + "adj_sales_deliveries_for_off_highway_construction", + "adj_sales_deliveries_for_off_highway_other", + "adj_sales_deliveries_to_commercial_consumers", + "adj_sales_deliveries_to_elect_utility_consumers", + "adj_sales_deliveries_to_farm_consumers", + "adj_sales_deliveries_to_industrial_consumers", + "adj_sales_deliveries_to_military_consumers", + "adj_sales_deliveries_to_off_highway_consumers", + "adj_sales_deliveries_to_oil_company_consumers", + "adj_sales_deliveries_to_on_highway_consumers", + "adj_sales_deliveries_to_other_end_users", + "adj_sales_deliveries_to_railroad_consumers", + "adj_sales_deliveries_to_residential_consumers", + "adj_sales_deliveries_to_vessel_bunker_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "distillate_fuel_oil", + "distillate_other_than_diesel", + "kerosene", + "no_1_distillate", + "no_2_diesel", + "no_2_diesel_high_sulfur", + "no_2_diesel_low_sulfur", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "no_2_distillate", + "no_2_fuel_oil_heating_oil", + "no_4_distillate", + "residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumAdjustedDistillateFuelOilAndKeroseneSalesByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumAdjustedDistillateFuelOilAndKeroseneSalesByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Adjusted Distillate Fuel Oil and Kerosene Sales by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumAdjustedDistillateFuelOilAndKeroseneSalesByEndUse" + } + }, + "/eia/petroleum/consumption_sales/adjusted_sales_of_distillate_fuel_oil_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Adjusted Sales of Distillate Fuel Oil by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.adjusted_sales_of_distillate_fuel_oil_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "adj_sales_deliveries_total_to_end_users", + "adj_sales_deliveries_to_commercial_consumers", + "adj_sales_deliveries_to_elect_utility_consumers", + "adj_sales_deliveries_to_farm_consumers", + "adj_sales_deliveries_to_industrial_consumers", + "adj_sales_deliveries_to_military_consumers", + "adj_sales_deliveries_to_off_highway_consumers", + "adj_sales_deliveries_to_oil_company_consumers", + "adj_sales_deliveries_to_on_highway_consumers", + "adj_sales_deliveries_to_other_end_users", + "adj_sales_deliveries_to_railroad_consumers", + "adj_sales_deliveries_to_residential_consumers", + "adj_sales_deliveries_to_vessel_bunker_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "distillate_fuel_oil", + "no_2_diesel" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 780 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumAdjustedSalesOfDistillateFuelOilByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumAdjustedSalesOfDistillateFuelOilByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Adjusted Sales of Distillate Fuel Oil by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumAdjustedSalesOfDistillateFuelOilByEndUse" + } + }, + "/eia/petroleum/consumption_sales/adjusted_sales_of_kerosene_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Adjusted Sales of Kerosene by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.adjusted_sales_of_kerosene_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "adj_sales_deliveries_total_to_end_users", + "adj_sales_deliveries_to_commercial_consumers", + "adj_sales_deliveries_to_farm_consumers", + "adj_sales_deliveries_to_industrial_consumers", + "adj_sales_deliveries_to_other_end_users", + "adj_sales_deliveries_to_residential_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 360 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumAdjustedSalesOfKeroseneByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumAdjustedSalesOfKeroseneByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Adjusted Sales of Kerosene by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumAdjustedSalesOfKeroseneByEndUse" + } + }, + "/eia/petroleum/consumption_sales/adjusted_sales_of_residual_fuel_oil_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Adjusted Sales of Residual Fuel Oil by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.adjusted_sales_of_residual_fuel_oil_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "adj_sales_deliveries_total_to_end_users", + "adj_sales_deliveries_transportation_total", + "adj_sales_deliveries_to_commercial_consumers", + "adj_sales_deliveries_to_elect_utility_consumers", + "adj_sales_deliveries_to_industrial_consumers", + "adj_sales_deliveries_to_military_consumers", + "adj_sales_deliveries_to_oil_company_consumers", + "adj_sales_deliveries_to_other_end_users" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 480 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumAdjustedSalesOfResidualFuelOilByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumAdjustedSalesOfResidualFuelOilByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Adjusted Sales of Residual Fuel Oil by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumAdjustedSalesOfResidualFuelOilByEndUse" + } + }, + "/eia/petroleum/consumption_sales/distillate_fuel_oil_and_kerosene_sales_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Distillate Fuel Oil and Kerosene Sales by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.distillate_fuel_oil_and_kerosene_sales_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_consumption", + "electric_power_consumption", + "industrial_consumption", + "off_highway_other", + "residential_consumption", + "sales_deliveries_to_farm_consumers", + "sales_deliveries_to_military_consumers", + "sales_deliveries_to_off_highway_construction", + "sales_deliveries_to_off_highway_consumers", + "sales_deliveries_to_oil_company_consumers", + "sales_deliveries_to_on_highway_consumers", + "sales_deliveries_to_other_end_users", + "sales_deliveries_to_railroad_consumers", + "sales_deliveries_to_vessel_bunkering_consumers", + "transportation_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "distillate_fuel_oil", + "distillate_other_than_diesel", + "kerosene", + "no_1_distillate", + "no_2_diesel", + "no_2_diesel_high_sulfur", + "no_2_diesel_low_sulfur", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "no_2_distillate", + "no_2_fuel_oil_heating_oil", + "no_4_distillate", + "residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumDistillateFuelOilAndKeroseneSalesByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumDistillateFuelOilAndKeroseneSalesByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Distillate Fuel Oil and Kerosene Sales by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumDistillateFuelOilAndKeroseneSalesByEndUse" + } + }, + "/eia/petroleum/consumption_sales/prime_supplier_sales_volumes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Prime Supplier Sales Volumes. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.prime_supplier_sales_volumes(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline", + "conventional_gasoline", + "conventional_premium_gasoline", + "conventional_regular_gasoline", + "gasoline_conventional_midgrade", + "gasoline_oxygenated_midgrade", + "gasoline_reformulated_midgrade", + "kerosene", + "kerosene_type_jet_fuel", + "midgrade_gasoline", + "naphtha_type_jet_fuel", + "no_1_distillate", + "no_2_diesel", + "no_2_diesel_high_sulfur", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "no_2_distillate", + "no_2_fuel_oil_heating_oil", + "no_4_distillate", + "oxygenated_gasoline", + "oxygenated_premium_gasoline", + "oxygenated_regular_gasoline", + "premium_gasoline", + "propane", + "reformulated_motor_gasoline", + "reformulated_premium_gasoline", + "reformulated_regular_gasoline", + "regular_gasoline", + "residual_fuel_oil", + "residual_fuel_oil_0_to_1_0_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "special_distillate_plus_kerosene", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumPrimeSupplierSalesVolumes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumPrimeSupplierSalesVolumes", + "openapi_extra": { + "widget_config": { + "name": "Prime Supplier Sales Volumes", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumPrimeSupplierSalesVolumes" + } + }, + "/eia/petroleum/consumption_sales/product_supplied": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Product Supplied. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.product_supplied(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "biofuel_fuels_excluding_fuel_ethanol", + "condensate_and_scrubber_oil", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "ethylene", + "finished_motor_gasoline", + "finished_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "isobutane_isobutylene", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "normal_butylene", + "other_biofuels", + "other_hydrocarbons", + "other_liquids", + "other_oils_for_petrochemical_feedstock_use", + "pentanes_plus", + "petrochemical_feedstocks", + "petroleum_coke", + "petroleum_coke_catalyst", + "petroleum_coke_marketable", + "propane", + "propane_and_propylene", + "propylene", + "refinery_olefins", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "still_gas", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 716 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumProductSupplied", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumProductSupplied", + "openapi_extra": { + "widget_config": { + "name": "Product Supplied", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumProductSupplied" + } + }, + "/eia/petroleum/consumption_sales/refiner_motor_gasoline_sales_volumes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refiner Motor Gasoline Sales Volumes. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.refiner_motor_gasoline_sales_volumes(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "bulk_sales", + "dtw_sales_volume", + "rack_sales_volume", + "retail_sales_by_refiners_and_gas_plants", + "through_company_outlets_volume_by_refiners_and_gas_plants", + "wholesale_resale_volume_by_refiners_and_gas_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_gasoline", + "midgrade_gasoline", + "oxygenated_gasoline", + "premium_gasoline", + "reformulated_motor_gasoline", + "regular_gasoline", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefinerMotorGasolineSalesVolumes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefinerMotorGasolineSalesVolumes", + "openapi_extra": { + "widget_config": { + "name": "Refiner Motor Gasoline Sales Volumes", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefinerMotorGasolineSalesVolumes" + } + }, + "/eia/petroleum/consumption_sales/refiner_residual_fuel_oil_and_no4_fuel_sales_volumes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refiner Residual Fuel Oil and No 4 Fuel Sales Volumes. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.refiner_residual_fuel_oil_and_no4_fuel_sales_volumes(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "retail_sales_by_refiners_and_gas_plants", + "wholesale_resale_volume_by_refiners_and_gas_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "no_4_distillate", + "residual_fuel_oil", + "residual_fuel_oil_0_to_1_0_sulfur", + "residual_fuel_oil_greater_than_1_sulfur" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "central_atlantic_no_4_distillate_retail_sales_by_refiners", + "central_atlantic_no_4_distillate_wholesale_resale_volume_by", + "central_atlantic_residual_fuel_oil_retail_sales_by_refiners", + "central_atlantic_padd_1b_residual_fuel_oil_sulfur_greater_than_1_retail_sales_by_refiners_thousand_gallons_per_day", + "central_atlantic_padd_1b_residual_fuel_oil_sulfur_greater_than_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "central_atlantic_padd_1b_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "central_atlantic_padd_1b_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "central_atlantic_residual_fuel_oil_wholesale_resale_volume", + "east_coast_no_4_distillate_retail_sales_by_refiners", + "east_coast_no_4_distillate_wholesale_resale_volume_by", + "east_coast_residual_fuel_oil_retail_sales_by_refiners", + "east_coast_residual_fuel_oil_sulfur_greater_than_1_retail", + "east_coast_residual_fuel_oil_sulfur_greater_than_1", + "east_coast_padd_1_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "east_coast_padd_1_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "east_coast_residual_fuel_oil_wholesale_resale_volume_by", + "gulf_coast_no_4_distillate_retail_sales_by_refiners", + "gulf_coast_no_4_distillate_wholesale_resale_volume_by", + "gulf_coast_residual_fuel_oil_retail_sales_by_refiners", + "gulf_coast_residual_fuel_oil_sulfur_greater_than_1_retail", + "gulf_coast_residual_fuel_oil_sulfur_greater_than_1", + "gulf_coast_padd_3_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "gulf_coast_padd_3_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "gulf_coast_residual_fuel_oil_wholesale_resale_volume_by", + "lower_atlantic_no_4_distillate_retail_sales_by_refiners", + "lower_atlantic_no_4_distillate_wholesale_resale_volume_by", + "lower_atlantic_residual_fuel_oil_retail_sales_by_refiners", + "lower_atlantic_padd_1c_residual_fuel_oil_sulfur_greater_than_1_retail_sales_by_refiners_thousand_gallons_per_day", + "lower_atlantic_padd_1c_residual_fuel_oil_sulfur_greater_than_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "lower_atlantic_padd_1c_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "lower_atlantic_padd_1c_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "lower_atlantic_residual_fuel_oil_wholesale_resale_volume_by", + "midwest_no_4_distillate_retail_sales_by_refiners", + "midwest_no_4_distillate_wholesale_resale_volume_by_refiners", + "midwest_residual_fuel_oil_retail_sales_by_refiners", + "midwest_residual_fuel_oil_sulfur_greater_than_1_retail", + "midwest_residual_fuel_oil_sulfur_greater_than_1_wholesale", + "midwest_padd_2_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "midwest_padd_2_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "midwest_residual_fuel_oil_wholesale_resale_volume_by", + "new_england_no_4_distillate_retail_sales_by_refiners", + "new_england_no_4_distillate_wholesale_resale_volume_by", + "new_england_residual_fuel_oil_retail_sales_by_refiners", + "new_england_residual_fuel_oil_sulfur_greater_than_1_retail", + "new_england_residual_fuel_oil_sulfur_greater_than_1", + "new_england_padd_1a_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "new_england_padd_1a_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "new_england_residual_fuel_oil_wholesale_resale_volume_by", + "rocky_mountain_no_4_distillate_retail_sales_by_refiners", + "rocky_mountain_no_4_distillate_wholesale_resale_volume_by", + "rocky_mountain_residual_fuel_oil_retail_sales_by_refiners", + "rocky_mountain_padd_4_residual_fuel_oil_sulfur_greater_than_1_retail_sales_by_refiners_thousand_gallons_per_day", + "rocky_mountain_padd_4_residual_fuel_oil_sulfur_greater_than_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "rocky_mountain_padd_4_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "rocky_mountain_padd_4_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "rocky_mountain_residual_fuel_oil_wholesale_resale_volume_by", + "us_no_4_distillate_retail_sales_by_refiners", + "us_no_4_distillate_wholesale_resale_volume_by_refiners", + "us_residual_fuel_oil_retail_sales_by_refiners", + "us_residual_fuel_oil_sulfur_greater_than_1_retail_sales_by", + "us_residual_fuel_oil_sulfur_greater_than_1_wholesale_resale", + "us_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail", + "us_residual_fuel_oil_sulfur_less_than_or_equal_to_1", + "us_residual_fuel_oil_wholesale_resale_volume_by_refiners", + "west_coast_no_4_distillate_retail_sales_by_refiners", + "west_coast_no_4_distillate_wholesale_resale_volume_by", + "west_coast_residual_fuel_oil_retail_sales_by_refiners", + "west_coast_residual_fuel_oil_sulfur_greater_than_1_retail", + "west_coast_residual_fuel_oil_sulfur_greater_than_1", + "west_coast_padd_5_residual_fuel_oil_sulfur_less_than_or_equal_to_1_retail_sales_by_refiners_thousand_gallons_per_day", + "west_coast_padd_5_residual_fuel_oil_sulfur_less_than_or_equal_to_1_wholesale_resale_volume_by_refiners_thousand_gallons_per_day", + "west_coast_residual_fuel_oil_wholesale_resale_volume_by" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefinerResidualFuelOilAndNo4FuelSalesVolumes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefinerResidualFuelOilAndNo4FuelSalesVolumes", + "openapi_extra": { + "widget_config": { + "name": "Refiner Residual Fuel Oil and No. 4 Fuel Sales Volumes", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefinerResidualFuelOilAndNo4FuelSalesVolumes" + } + }, + "/eia/petroleum/consumption_sales/refiner_sales_volumes_of_other_petroleum_products": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refiner Sales Volumes of Other Petroleum Products. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.refiner_sales_volumes_of_other_petroleum_products(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "retail_sales_by_refiners_and_gas_plants", + "wholesale_resale_volume_by_refiners_and_gas_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline", + "kerosene", + "kerosene_type_jet_fuel", + "no_1_distillate", + "no_2_diesel", + "no_2_diesel_high_sulfur", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "no_2_distillate", + "no_2_fuel_oil_heating_oil", + "propane" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefinerSalesVolumesOfOtherPetroleumProducts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefinerSalesVolumesOfOtherPetroleumProducts", + "openapi_extra": { + "widget_config": { + "name": "Refiner Sales Volumes of Other Petroleum Products", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefinerSalesVolumesOfOtherPetroleumProducts" + } + }, + "/eia/petroleum/consumption_sales/sales_of_distillate_fuel_oil_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sales of Distillate Fuel Oil by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.sales_of_distillate_fuel_oil_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_consumption", + "electric_power_consumption", + "industrial_consumption", + "residential_consumption", + "retail_deliveries", + "sales_deliveries_to_farm_consumers", + "sales_deliveries_to_military_consumers", + "sales_deliveries_to_off_highway_consumers", + "sales_deliveries_to_oil_company_consumers", + "sales_deliveries_to_on_highway_consumers", + "sales_deliveries_to_other_end_users", + "sales_deliveries_to_railroad_consumers", + "sales_deliveries_to_vessel_bunkering_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "distillate_fuel_oil", + "no_2_diesel" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 780 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumSalesOfDistillateFuelOilByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumSalesOfDistillateFuelOilByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Sales of Distillate Fuel Oil by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumSalesOfDistillateFuelOilByEndUse" + } + }, + "/eia/petroleum/consumption_sales/sales_of_kerosene_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sales of Kerosene by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.sales_of_kerosene_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_consumption", + "industrial_consumption", + "residential_consumption", + "retail_deliveries", + "sales_deliveries_to_farm_consumers", + "sales_deliveries_to_other_end_users" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 360 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumSalesOfKeroseneByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumSalesOfKeroseneByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Sales of Kerosene by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumSalesOfKeroseneByEndUse" + } + }, + "/eia/petroleum/consumption_sales/sales_of_residual_fuel_oil_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sales of Residual Fuel Oil by End Use. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.sales_of_residual_fuel_oil_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_consumption", + "electric_power_consumption", + "industrial_consumption", + "retail_deliveries", + "sales_deliveries_to_military_consumers", + "sales_deliveries_to_oil_company_consumers", + "sales_deliveries_to_other_end_users", + "sales_deliveries_to_vessel_bunkering_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 480 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumSalesOfResidualFuelOilByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumSalesOfResidualFuelOilByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Sales of Residual Fuel Oil by End Use", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumSalesOfResidualFuelOilByEndUse" + } + }, + "/eia/petroleum/consumption_sales/us_weekly_product_supplied": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Weekly Product Supplied. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.consumption_sales.us_weekly_product_supplied(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "distillate_fuel_oil", + "finished_motor_gasoline", + "kerosene_type_jet_fuel", + "other_oils", + "propane_and_propylene", + "residual_fuel_oil", + "total_petroleum_products" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_product_supplied_of_distillate_fuel_oil", + "us_product_supplied_of_finished_motor_gasoline", + "us_product_supplied_of_kerosene_type_jet_fuel", + "us_product_supplied_of_other_oils", + "us_product_supplied_of_petroleum_products", + "us_product_supplied_of_propane_and_propylene", + "us_product_supplied_of_residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumUsWeeklyProductSupplied", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumUsWeeklyProductSupplied", + "openapi_extra": { + "widget_config": { + "name": "U.S. Weekly Product Supplied", + "category": "EIA", + "subCategory": "Consumption/Sales", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumUsWeeklyProductSupplied" + } + }, + "/eia/petroleum/crude_reserves_and_production/average_depth_of_crude_oil_and_natural_gas_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Average Depth of Crude Oil and Natural Gas Wells. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.average_depth_of_crude_oil_and_natural_gas_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_depth_of_developmental_wells_drilled", + "average_depth_of_exploratory_wells_drilled", + "average_depth_of_exploratory_and_developmental_wells_drilled" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_average_depth_of_crude_oil_developmental_wells_drilled", + "us_average_depth_of_crude_oil_exploratory_wells_drilled", + "us_average_depth_of_crude_oil_exploratory_and_developmental", + "us_average_depth_of_crude_oil_natural_gas_and_dry_developmental_wells_drilled_feet_per_well", + "us_average_depth_of_crude_oil_natural_gas_and_dry_exploratory_wells_drilled_feet_per_well", + "us_average_depth_of_crude_oil_natural_gas_and_dry_exploratory_and_developmental_wells_drilled_feet_per_well", + "us_average_depth_of_dry_exploratory_and_developmental_wells", + "us_average_depth_of_dry_holes_developmental_wells_drilled", + "us_average_depth_of_dry_holes_exploratory_wells_drilled", + "us_average_depth_of_natural_gas_developmental_wells_drilled", + "us_average_depth_of_natural_gas_exploratory_wells_drilled", + "us_average_depth_of_natural_gas_exploratory_and" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumAverageDepthOfCrudeOilAndNaturalGasWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumAverageDepthOfCrudeOilAndNaturalGasWells", + "openapi_extra": { + "widget_config": { + "name": "Average Depth of Crude Oil and Natural Gas Wells", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumAverageDepthOfCrudeOilAndNaturalGasWells" + } + }, + "/eia/petroleum/crude_reserves_and_production/costs_of_crude_oil_and_natural_gas_wells_drilled": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Costs of Crude Oil and Natural Gas Wells Drilled. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.costs_of_crude_oil_and_natural_gas_wells_drilled(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "nominal_cost_per_foot_of_dry_wells_drilled", + "nominal_cost_per_well_drilled", + "real_cost", + "real_cost_per_foot" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_nominal_cost_per_crude_oil_well_drilled", + "us_nominal_cost_per_crude_oil_natural_gas_and_dry_well", + "us_nominal_cost_per_dry_well_drilled", + "us_nominal_cost_per_foot_of_crude_oil_wells_drilled", + "us_nominal_cost_per_foot_of_crude_oil_natural_gas_and_dry", + "us_nominal_cost_per_foot_of_dry_wells_drilled", + "us_nominal_cost_per_foot_of_natural_gas_wells_drilled", + "us_nominal_cost_per_natural_gas_well_drilled", + "us_real_cost_per_crude_oil_natural_gas_and_dry_well_drilled", + "us_real_cost_per_foot_of_crude_oil_natural_gas_and_dry" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCostsOfCrudeOilAndNaturalGasWellsDrilled", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCostsOfCrudeOilAndNaturalGasWellsDrilled", + "openapi_extra": { + "widget_config": { + "name": "Costs of Crude Oil and Natural Gas Wells Drilled", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCostsOfCrudeOilAndNaturalGasWellsDrilled" + } + }, + "/eia/petroleum/crude_reserves_and_production/crude_oil_and_lease_condensate_production_by_api_gravity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil and Lease Condensate Production by API Gravity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.crude_oil_and_lease_condensate_production_by_api_gravity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_gravity_20_0_percent_or_less", + "crude_gravity_20_1_to_25_0_percent", + "crude_gravity_25_1_to_30_0_percent", + "crude_gravity_30_0_percent_or_less", + "crude_gravity_30_1_to_35_0_percent", + "crude_gravity_30_1_to_40_0_percent", + "crude_gravity_35_1_to_40_0_percent", + "crude_gravity_40_1_to_45_0_percent", + "crude_gravity_40_1_to_50_0_percent", + "crude_gravity_45_1_to_50_0_percent", + "crude_gravity_50_1_percent_or_more", + "crude_gravity_50_1_to_55_0_percent", + "crude_gravity_55_1_percent_or_more", + "crude_gravity_of_all", + "crude_gravity_of_unkown" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "na", + "ohio", + "texas", + "usa_ar", + "usa_ks", + "usa_la", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arkansas_crude_oil_and_lease_condensate_production_for_30_0", + "arkansas_crude_oil_and_lease_condensate_production_for_30_1", + "arkansas_crude_oil_and_lease_condensate_production_for_40_1", + "arkansas_crude_oil_and_lease_condensate_production_for_50_1", + "arkansas_crude_oil_and_lease_condensate_production_for_all", + "california_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "california_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "california_crude_oil_and_lease_condensate_production_for_40", + "california_crude_oil_and_lease_condensate_production_for_50", + "california_crude_oil_and_lease_condensate_production_for", + "colorado_crude_oil_and_lease_condensate_production_for_30_0", + "colorado_crude_oil_and_lease_condensate_production_for_30_1", + "colorado_crude_oil_and_lease_condensate_production_for_40_1", + "colorado_crude_oil_and_lease_condensate_production_for_50_1", + "colorado_crude_oil_and_lease_condensate_production_for_all", + "federal_offshore_gulf_of_america_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "federal_offshore_gulf_of_america_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "federal_offshore_gulf_of_america_crude_oil_and_lease_condensate_production_for_40_1_to_50_0_degrees_api_gravity_thousand_barrels_per_day", + "federal_offshore_gulf_of_america_crude_oil_and_lease_condensate_production_for_50_1_or_higher_degrees_api_gravity_thousand_barrels_per_day", + "federal_offshore_gulf_of_america_crude_oil_and_lease_condensate_production_for_all_api_gravity_thousand_barrels_per_day", + "kansas_crude_oil_and_lease_condensate_production_for_30_0", + "kansas_crude_oil_and_lease_condensate_production_for_30_1", + "kansas_crude_oil_and_lease_condensate_production_for_40_1", + "kansas_crude_oil_and_lease_condensate_production_for_50_1", + "kansas_crude_oil_and_lease_condensate_production_for_all", + "louisiana_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "louisiana_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "louisiana_crude_oil_and_lease_condensate_production_for_40", + "louisiana_crude_oil_and_lease_condensate_production_for_50", + "louisiana_crude_oil_and_lease_condensate_production_for_all", + "lower_48_states_crude_oil_and_lease_condensate_production_for_20_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_20_1_to_25_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_25_1_to_30_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_30_1_to_35_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_35_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_40_1_to_45_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_45_1_to_50_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_50_1_to_55_0_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_55_1_or_higher_degrees_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_unknown_api_gravity_thousand_barrels_per_day", + "lower_48_states_crude_oil_and_lease_condensate_production_for_all_api_gravity_thousand_barrels_per_day", + "montana_crude_oil_and_lease_condensate_production_for_30_0", + "montana_crude_oil_and_lease_condensate_production_for_30_1", + "montana_crude_oil_and_lease_condensate_production_for_40_1", + "montana_crude_oil_and_lease_condensate_production_for_50_1", + "montana_crude_oil_and_lease_condensate_production_for_all", + "new_mexico_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "new_mexico_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "new_mexico_crude_oil_and_lease_condensate_production_for_40", + "new_mexico_crude_oil_and_lease_condensate_production_for_50", + "new_mexico_crude_oil_and_lease_condensate_production_for", + "north_dakota_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "north_dakota_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "north_dakota_crude_oil_and_lease_condensate_production_for_40_1_to_50_0_degrees_api_gravity_thousand_barrels_per_day", + "north_dakota_crude_oil_and_lease_condensate_production_for_50_1_or_higher_degrees_api_gravity_thousand_barrels_per_day", + "north_dakota_crude_oil_and_lease_condensate_production_for_all_api_gravity_thousand_barrels_per_day", + "ohio_crude_oil_and_lease_condensate_production_for_30_0_or", + "ohio_crude_oil_and_lease_condensate_production_for_30_1_to", + "ohio_crude_oil_and_lease_condensate_production_for_40_1_to", + "ohio_crude_oil_and_lease_condensate_production_for_50_1_or", + "ohio_crude_oil_and_lease_condensate_production_for_all_api", + "oklahoma_crude_oil_and_lease_condensate_production_for_30_0", + "oklahoma_crude_oil_and_lease_condensate_production_for_30_1", + "oklahoma_crude_oil_and_lease_condensate_production_for_40_1", + "oklahoma_crude_oil_and_lease_condensate_production_for_50_1", + "oklahoma_crude_oil_and_lease_condensate_production_for_all", + "other_states_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "other_states_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "other_states_crude_oil_and_lease_condensate_production_for_40_1_to_50_0_degrees_api_gravity_thousand_barrels_per_day", + "other_states_crude_oil_and_lease_condensate_production_for_50_1_or_higher_degrees_api_gravity_thousand_barrels_per_day_ull", + "other_states_crude_oil_and_lease_condensate_production_for_all_api_gravity_thousand_barrels_per_day", + "pennsylvania_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "pennsylvania_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "pennsylvania_crude_oil_and_lease_condensate_production_for_40_1_to_50_0_degrees_api_gravity_thousand_barrels_per_day", + "pennsylvania_crude_oil_and_lease_condensate_production_for_50_1_or_higher_degrees_api_gravity_thousand_barrels_per_day", + "pennsylvania_crude_oil_and_lease_condensate_production_for_all_api_gravity_thousand_barrels_per_day", + "texas_crude_oil_and_lease_condensate_production_for_30_0_or", + "texas_crude_oil_and_lease_condensate_production_for_30_1_to", + "texas_crude_oil_and_lease_condensate_production_for_40_1_to", + "texas_crude_oil_and_lease_condensate_production_for_50_1_or", + "texas_crude_oil_and_lease_condensate_production_for_all_api", + "utah_crude_oil_and_lease_condensate_production_for_30_0_or", + "utah_crude_oil_and_lease_condensate_production_for_30_1_to", + "utah_crude_oil_and_lease_condensate_production_for_40_1_to", + "utah_crude_oil_and_lease_condensate_production_for_50_1_or", + "utah_crude_oil_and_lease_condensate_production_for_all_api", + "west_virginia_crude_oil_and_lease_condensate_production_for_30_0_or_lower_degrees_api_gravity_thousand_barrels_per_day", + "west_virginia_crude_oil_and_lease_condensate_production_for_30_1_to_40_0_degrees_api_gravity_thousand_barrels_per_day", + "west_virginia_crude_oil_and_lease_condensate_production_for_40_1_to_50_0_degrees_api_gravity_thousand_barrels_per_day", + "west_virginia_crude_oil_and_lease_condensate_production_for_50_1_or_higher_degrees_api_gravity_thousand_barrels_per_day", + "west_virginia_crude_oil_and_lease_condensate_production_for_all_api_gravity_thousand_barrels_per_day", + "wyoming_crude_oil_and_lease_condensate_production_for_30_0", + "wyoming_crude_oil_and_lease_condensate_production_for_30_1", + "wyoming_crude_oil_and_lease_condensate_production_for_40_1", + "wyoming_crude_oil_and_lease_condensate_production_for_50_1", + "wyoming_crude_oil_and_lease_condensate_production_for_all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilAndLeaseCondensateProductionByApiGravity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilAndLeaseCondensateProductionByApiGravity", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil and Lease Condensate Production by API Gravity", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilAndLeaseCondensateProductionByApiGravity" + } + }, + "/eia/petroleum/crude_reserves_and_production/crude_oil_and_natural_gas_drilling_activity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil and Natural Gas Drilling Activity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.crude_oil_and_natural_gas_drilling_activity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "active_well_service_rigs_in_operation", + "rotary_rigs_in_operation" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil_and_natural_gas", + "rotary_rigs_in_operation", + "rotary_rigs_in_operation_gas", + "rotary_rigs_in_operation_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_crude_oil_rotary_rigs_in_operation", + "us_crude_oil_and_natural_gas_active_well_service_rigs_in", + "us_crude_oil_and_natural_gas_rotary_rigs_in_operation", + "us_natural_gas_rotary_rigs_in_operation", + "us_offshore_crude_oil_and_natural_gas_rotary_rigs_in", + "us_onshore_crude_oil_and_natural_gas_rotary_rigs_in" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilAndNaturalGasDrillingActivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilAndNaturalGasDrillingActivity", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil and Natural Gas Drilling Activity", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilAndNaturalGasDrillingActivity" + } + }, + "/eia/petroleum/crude_reserves_and_production/crude_oil_and_natural_gas_exploratory_and_development_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil and Natural Gas Exploratory and Development Wells. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.crude_oil_and_natural_gas_exploratory_and_development_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "developmental_wells_drilled", + "exploratory_wells_drilled", + "exploratory_and_developmental_wells_drilled", + "footage_drilled_for_exploratory_and_developmental_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_crude_oil_developmental_wells_drilled", + "us_crude_oil_exploratory_wells_drilled", + "us_crude_oil_exploratory_and_developmental_wells_drilled", + "us_crude_oil_natural_gas_and_dry_developmental_wells_drilled", + "us_crude_oil_natural_gas_and_dry_exploratory_wells_drilled", + "us_crude_oil_natural_gas_and_dry_exploratory_and", + "us_dry_developmental_wells_drilled", + "us_dry_exploratory_wells_drilled", + "us_dry_exploratory_and_developmental_wells_drilled", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry", + "us_natural_gas_developmental_wells_drilled", + "us_natural_gas_exploratory_wells_drilled", + "us_natural_gas_exploratory_and_developmental_wells_drilled" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilAndNaturalGasExploratoryAndDevelopmentWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilAndNaturalGasExploratoryAndDevelopmentWells", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil and Natural Gas Exploratory and Development Wells", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilAndNaturalGasExploratoryAndDevelopmentWells" + } + }, + "/eia/petroleum/crude_reserves_and_production/crude_oil_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.crude_oil_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ans_crude_oil", + "crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_pa", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_field_production_of_crude_oil_thousand_barrels_per_day", + "alabama_field_production_of_crude_oil_thousand_barrels", + "alaska_field_production_of_crude_oil_thousand_barrels_per_day", + "alaska_field_production_of_crude_oil_thousand_barrels", + "alaska_north_slope_crude_oil_production_thousand_barrels_per_day", + "alaska_north_slope_crude_oil_production_thousand_barrels", + "alaska_south_field_production_of_crude_oil_thousand_barrels_per_day", + "alaska_south_field_production_of_crude_oil_thousand_barrels", + "arizona_field_production_of_crude_oil_thousand_barrels_per_day", + "arizona_field_production_of_crude_oil_thousand_barrels", + "arkansas_field_production_of_crude_oil_thousand_barrels_per_day", + "arkansas_field_production_of_crude_oil_thousand_barrels", + "california_field_production_of_crude_oil_thousand_barrels_per_day", + "california_field_production_of_crude_oil_thousand_barrels", + "colorado_field_production_of_crude_oil_thousand_barrels_per_day", + "colorado_field_production_of_crude_oil_thousand_barrels", + "east_coast_padd_1_field_production_of_crude_oil_thousand_barrels_per_day", + "east_coast_padd_1_field_production_of_crude_oil_thousand_barrels", + "federal_offshore_padd_5_field_production_of_crude_oil_thousand_barrels_per_day", + "federal_offshore_padd_5_field_production_of_crude_oil_thousand_barrels", + "federal_offshore_gulf_of_america_field_production_of_crude_oil_thousand_barrels_per_day", + "federal_offshore_gulf_of_america_field_production_of_crude_oil_thousand_barrels", + "florida_field_production_of_crude_oil_thousand_barrels_per_day", + "florida_field_production_of_crude_oil_thousand_barrels", + "gulf_coast_padd_3_field_production_of_crude_oil_thousand_barrels_per_day", + "gulf_coast_padd_3_field_production_of_crude_oil_thousand_barrels", + "idaho_field_production_of_crude_oil_thousand_barrels_per_day", + "idaho_field_production_of_crude_oil_thousand_barrels", + "illinois_field_production_of_crude_oil_thousand_barrels_per_day", + "illinois_field_production_of_crude_oil_thousand_barrels", + "indiana_field_production_of_crude_oil_thousand_barrels_per_day", + "indiana_field_production_of_crude_oil_thousand_barrels", + "kansas_field_production_of_crude_oil_thousand_barrels_per_day", + "kansas_field_production_of_crude_oil_thousand_barrels", + "kentucky_field_production_of_crude_oil_thousand_barrels_per_day", + "kentucky_field_production_of_crude_oil_thousand_barrels", + "louisiana_field_production_of_crude_oil_thousand_barrels_per_day", + "louisiana_field_production_of_crude_oil_thousand_barrels", + "michigan_field_production_of_crude_oil_thousand_barrels_per_day", + "michigan_field_production_of_crude_oil_thousand_barrels", + "midwest_padd_2_field_production_of_crude_oil_thousand_barrels_per_day", + "midwest_padd_2_field_production_of_crude_oil_thousand_barrels", + "mississippi_field_production_of_crude_oil_thousand_barrels_per_day", + "mississippi_field_production_of_crude_oil_thousand_barrels", + "missouri_field_production_of_crude_oil_thousand_barrels_per_day", + "missouri_field_production_of_crude_oil_thousand_barrels", + "montana_field_production_of_crude_oil_thousand_barrels_per_day", + "montana_field_production_of_crude_oil_thousand_barrels", + "nebraska_field_production_of_crude_oil_thousand_barrels_per_day", + "nebraska_field_production_of_crude_oil_thousand_barrels", + "nevada_field_production_of_crude_oil_thousand_barrels_per_day", + "nevada_field_production_of_crude_oil_thousand_barrels", + "new_mexico_field_production_of_crude_oil_thousand_barrels_per_day", + "new_mexico_field_production_of_crude_oil_thousand_barrels", + "new_york_field_production_of_crude_oil_thousand_barrels_per_day", + "new_york_field_production_of_crude_oil_thousand_barrels", + "north_dakota_field_production_of_crude_oil_thousand_barrels_per_day", + "north_dakota_field_production_of_crude_oil_thousand_barrels", + "ohio_field_production_of_crude_oil_thousand_barrels_per_day", + "ohio_field_production_of_crude_oil_thousand_barrels", + "oklahoma_field_production_of_crude_oil_thousand_barrels_per_day", + "oklahoma_field_production_of_crude_oil_thousand_barrels", + "pennsylvania_field_production_of_crude_oil_thousand_barrels_per_day", + "pennsylvania_field_production_of_crude_oil_thousand_barrels", + "rocky_mountain_padd_4_field_production_of_crude_oil_thousand_barrels_per_day", + "rocky_mountain_padd_4_field_production_of_crude_oil_thousand_barrels", + "south_dakota_field_production_of_crude_oil_thousand_barrels_per_day", + "south_dakota_field_production_of_crude_oil_thousand_barrels", + "tennessee_field_production_of_crude_oil_thousand_barrels_per_day", + "tennessee_field_production_of_crude_oil_thousand_barrels", + "texas_field_production_of_crude_oil_thousand_barrels_per_day", + "texas_field_production_of_crude_oil_thousand_barrels", + "us_field_production_of_crude_oil_thousand_barrels_per_day", + "us_field_production_of_crude_oil_thousand_barrels", + "utah_field_production_of_crude_oil_thousand_barrels_per_day", + "utah_field_production_of_crude_oil_thousand_barrels", + "virginia_field_production_of_crude_oil_thousand_barrels_per_day", + "virginia_field_production_of_crude_oil_thousand_barrels", + "west_coast_padd_5_field_production_of_crude_oil_thousand_barrels_per_day", + "west_coast_padd_5_field_production_of_crude_oil_thousand_barrels", + "west_virginia_field_production_of_crude_oil_thousand_barrels_per_day", + "west_virginia_field_production_of_crude_oil_thousand_barrels", + "wyoming_field_production_of_crude_oil_thousand_barrels_per_day", + "wyoming_field_production_of_crude_oil_thousand_barrels" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilProduction", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil Production", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilProduction" + } + }, + "/eia/petroleum/crude_reserves_and_production/crude_oil_proved_reserves_reserves_changes_and_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil Proved Reserves, Reserves Changes, and Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.crude_oil_proved_reserves_reserves_changes_and_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "production_from_reserves", + "proved_reserves", + "reserves_acquisitions", + "reserves_adjustments", + "reserves_extensions", + "reserves_extensions_and_discoveries", + "reserves_new_field_discoveries", + "reserves_new_reservoir_discoveries_in_old_fields", + "reserves_revision_decreases", + "reserves_revision_increases", + "reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 572 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilProvedReservesReservesChangesAndProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilProvedReservesReservesChangesAndProduction", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil Proved Reserves, Reserves Changes, and Production", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilProvedReservesReservesChangesAndProduction" + } + }, + "/eia/petroleum/crude_reserves_and_production/crude_plus_lease_condensate_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil plus Lease Condensate Proved Reserves, Reserves Changes, and Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.crude_plus_lease_condensate_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "production_from_reserves", + "proved_reserves", + "reserves_acquisitions", + "reserves_adjustments", + "reserves_extensions", + "reserves_extensions_and_discoveries", + "reserves_new_field_discoveries", + "reserves_new_reservoir_discoveries_in_old_fields", + "reserves_revision_decreases", + "reserves_revision_increases", + "reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 572 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudePlusLeaseCondensateProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudePlusLeaseCondensateProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil plus Lease Condensate Proved Reserves, Reserves Changes, and Production", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudePlusLeaseCondensateProvedReserves" + } + }, + "/eia/petroleum/crude_reserves_and_production/footage_drilled_for_crude_oil_and_natural_gas_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Footage Drilled for Crude Oil and Natural Gas Wells. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.footage_drilled_for_crude_oil_and_natural_gas_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "footage_drilled_for_developmental_wells", + "footage_drilled_for_exploratory_wells", + "footage_drilled_for_exploratory_and_developmental_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_footage_drilled_for_crude_oil_developmental_wells", + "us_footage_drilled_for_crude_oil_exploratory_wells", + "us_footage_drilled_for_crude_oil_exploratory_and", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry_developmental_wells_thousand_feet", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry_exploratory_wells_thousand_feet", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry_exploratory_and_developmental_wells_thousand_feet", + "us_footage_drilled_for_dry_developmental_wells", + "us_footage_drilled_for_dry_exploratory_wells", + "us_footage_drilled_for_dry_exploratory_and_developmental", + "us_footage_drilled_for_natural_gas_developmental_wells", + "us_footage_drilled_for_natural_gas_exploratory_wells", + "us_footage_drilled_for_natural_gas_exploratory_and" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFootageDrilledForCrudeOilAndNaturalGasWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFootageDrilledForCrudeOilAndNaturalGasWells", + "openapi_extra": { + "widget_config": { + "name": "Footage Drilled for Crude Oil and Natural Gas Wells", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFootageDrilledForCrudeOilAndNaturalGasWells" + } + }, + "/eia/petroleum/crude_reserves_and_production/gulf_of_america_federal_offshore_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Gulf of America Federal Offshore Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.gulf_of_america_federal_offshore_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "dry_production_from_reserves", + "dry_reserves_based_production_deepwater_percentage", + "dry_reserves_based_production_from_greater_than_200_meters", + "dry_reserves_based_production_from_less_than_200_meters", + "lease_condensate_reserves_based_production", + "lease_condensate_reserves_based_production_deepwater", + "lease_condensate_reserves_based_production_from_greater", + "lease_condensate_reserves_based_production_from_less_than", + "production_from_reserves", + "reserves_based_production_deepwater_percentage", + "reserves_based_production_from_greater_than_200_meters", + "reserves_based_production_from_less_than_200_meters", + "wet_after_lease_separation_reserves_based_production", + "wet_after_lease_separation_reserves_based_production_from_greater_than_200_meters", + "wet_after_lease_separation_reserves_based_production_from_less_than_200_meters", + "wet_after_lease_separation_reserves_based_production_from_reserves" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil", + "natural_gas", + "natural_gas_liquids_and_liquid_refinery_gases" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "gulf_of_america_federal_offshore_crude_oil_production", + "gulf_of_america_federal_offshore_crude_oil_production_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_crude_oil_production_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_dry_natural_gas_production_billion_cubic_feet", + "gulf_of_america_federal_offshore_dry_natural_gas_production_from_greater_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_dry_natural_gas_production_from_less_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_production_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_production_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_production_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_production_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_production_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_production_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_production_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_production_from_greater_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_production_from_less_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_percentage_of_crude_oil", + "gulf_of_america_federal_offshore_percentage_of_dry_natural", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_liquids_lease_condensate_production_from_greater_than_200_meters_deep", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_liquids_production_from_greater_than_200_meters_deep", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_wet_after_lease_separation_production_from_greater_than_200_meters_deep" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumGulfOfAmericaFederalOffshoreProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumGulfOfAmericaFederalOffshoreProduction", + "openapi_extra": { + "widget_config": { + "name": "Gulf of America Federal Offshore Production", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumGulfOfAmericaFederalOffshoreProduction" + } + }, + "/eia/petroleum/crude_reserves_and_production/maximum_us_active_seismic_crew_counts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Maximum US Active Seismic Crew Counts. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.maximum_us_active_seismic_crew_counts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "maximum_number_of_active_crews_engaged_in_four_dimensional", + "maximum_number_of_active_crews_engaged_in_sismic_surveying", + "maximum_number_of_active_crews_engaged_in_three_dimensional", + "maximum_number_of_active_crews_engaged_in_two_dimensional" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "us", + "usa_ak" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alaska_maximum_number_of_active_crews_engaged_in_four", + "alaska_maximum_number_of_active_crews_engaged_in_seismic", + "alaska_maximum_number_of_active_crews_engaged_in_three", + "alaska_maximum_number_of_active_crews_engaged_in_two", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_seismic_surveying_count", + "us_maximum_number_of_active_crews_engaged_in_seismic", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_four_dimensional_seismic_surveying_count", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_three_dimensional_seismic_surveying_count", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_two_dimensional_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_four_dimensional_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_three_dimensional_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_two_dimensional_seismic_surveying_count" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumMaximumUsActiveSeismicCrewCounts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumMaximumUsActiveSeismicCrewCounts", + "openapi_extra": { + "widget_config": { + "name": "Maximum U.S. Active Seismic Crew Counts", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumMaximumUsActiveSeismicCrewCounts" + } + }, + "/eia/petroleum/crude_reserves_and_production/proved_nonproducing_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Proved Nonproducing Reserves. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.crude_reserves_and_production.proved_nonproducing_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "associated_dissolved_reserves_in_nonproducing_reservoirs", + "lease_condensate_reserves_in_nonproducing_reservoirs", + "nonassociated_reserves_in_nonproducing_reservoirs", + "reserves_in_nonproducing_reservoirs", + "wet_after_lease_separation_reserves_in_nonproducing" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil", + "natural_gas", + "natural_gas_liquids_and_liquid_refinery_gases" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 270 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumProvedNonproducingReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumProvedNonproducingReserves", + "openapi_extra": { + "widget_config": { + "name": "Proved Nonproducing Reserves", + "category": "EIA", + "subCategory": "Crude Reserves and Production", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumProvedNonproducingReserves" + } + }, + "/eia/petroleum/imports_exports_and_movements/exports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Exports. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.exports(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "biofuel_fuels", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "finished_motor_gasoline", + "finished_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "isobutane_isobutylene", + "kerosene", + "kerosene_and_light_oils", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "other_biofuels", + "other_liquids", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "oxygenates", + "pentanes_plus", + "petroleum_coke", + "propane", + "propane_and_propylene", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 612 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumExports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumExports", + "openapi_extra": { + "widget_config": { + "name": "Exports", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumExports" + } + }, + "/eia/petroleum/imports_exports_and_movements/exports_by_destination": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Exports by Destination. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.exports_by_destination(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "ethane", + "finished_motor_gasoline", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "other_biofuels", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "pentanes_plus", + "petroleum_coke", + "propane", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 216 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumExportsByDestination", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumExportsByDestination", + "openapi_extra": { + "widget_config": { + "name": "Exports by Destination", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumExportsByDestination" + } + }, + "/eia/petroleum/imports_exports_and_movements/imports_by_area_of_entry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Imports by Area of Entry. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.imports_by_area_of_entry(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "biofuel_fuels", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_0_to_15_ppm_sulfur_bonded", + "distillate_fuel_oil_0_to_15_ppm_sulfur_not_bonded", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_bonded", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_not", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur_bonded", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur_not_bonded", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur_bonded", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur_not", + "ethane", + "ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_reformulated_other", + "finished_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "heavy_gas_oils", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "isobutylene", + "kerosene", + "kerosene_and_light_oils", + "kerosene_type_jet_fuel", + "kerosene_type_jet_fuel_bonded", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butylene", + "other_biofuels", + "other_conventional_motor_gasoline", + "other_hydrocarbons", + "other_kerosene_type_jet_fuel", + "other_liquids", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "oxygenates", + "pentanes_plus", + "petrochemical_feedstocks", + "petroleum_coke", + "propane", + "propylene", + "refinery_olefins", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "renewable_diesel_fuel", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "residuum", + "special_naphthas", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 870 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumImportsByAreaOfEntry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumImportsByAreaOfEntry", + "openapi_extra": { + "widget_config": { + "name": "Imports by Area of Entry", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumImportsByAreaOfEntry" + } + }, + "/eia/petroleum/imports_exports_and_movements/imports_by_processing_area": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Imports by Processing Area. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.imports_by_processing_area(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline_blending_components", + "crude_oil", + "heavy_gas_oils", + "kerosene_and_light_oils", + "naphthas_and_lighter", + "residuum", + "unfinished_oils" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_padd_1_imports_by_padd_of_processing_of_crude_oil_thousand_barrels_per_day", + "east_coast_padd_1_imports_by_padd_of_processing_of_crude_oil_thousand_barrels", + "east_coast_padd_1_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels_per_day", + "east_coast_padd_1_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels", + "east_coast_padd_1_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels_per_day", + "east_coast_padd_1_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels", + "east_coast_padd_1_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels_per_day", + "east_coast_padd_1_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels", + "east_coast_padd_1_imports_by_padd_of_processing_of_residuum_thousand_barrels_per_day", + "east_coast_padd_1_imports_by_padd_of_processing_of_residuum_thousand_barrels", + "east_coast_padd_1_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels_per_day", + "east_coast_padd_1_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_crude_oil_thousand_barrels_per_day", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_crude_oil_thousand_barrels", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels_per_day", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels_per_day", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels_per_day", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_residuum_thousand_barrels_per_day", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_residuum_thousand_barrels", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels_per_day", + "gulf_coast_padd_3_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels", + "midwest_padd_2_imports_by_padd_of_processing_of_crude_oil_thousand_barrels_per_day", + "midwest_padd_2_imports_by_padd_of_processing_of_crude_oil_thousand_barrels", + "midwest_padd_2_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels_per_day", + "midwest_padd_2_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels", + "midwest_padd_2_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels_per_day", + "midwest_padd_2_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels", + "midwest_padd_2_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels_per_day", + "midwest_padd_2_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels", + "midwest_padd_2_imports_by_padd_of_processing_of_residuum_thousand_barrels_per_day", + "midwest_padd_2_imports_by_padd_of_processing_of_residuum_thousand_barrels", + "midwest_padd_2_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels_per_day", + "midwest_padd_2_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_crude_oil_thousand_barrels_per_day", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_crude_oil_thousand_barrels", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels_per_day", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels_per_day", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_residuum_thousand_barrels_per_day", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_residuum_thousand_barrels", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels_per_day", + "rocky_mountain_padd_4_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels", + "west_coast_padd_5_imports_by_padd_of_processing_of_crude_oil_thousand_barrels_per_day", + "west_coast_padd_5_imports_by_padd_of_processing_of_crude_oil_thousand_barrels", + "west_coast_padd_5_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels_per_day", + "west_coast_padd_5_imports_by_padd_of_processing_of_heavy_gas_oils_thousand_barrels", + "west_coast_padd_5_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels_per_day", + "west_coast_padd_5_imports_by_padd_of_processing_of_kerosene_and_light_oils_thousand_barrels", + "west_coast_padd_5_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels_per_day", + "west_coast_padd_5_imports_by_padd_of_processing_of_naphthas_and_lighter_thousand_barrels", + "west_coast_padd_5_imports_by_padd_of_processing_of_residuum_thousand_barrels_per_day", + "west_coast_padd_5_imports_by_padd_of_processing_of_residuum_thousand_barrels", + "west_coast_padd_5_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels_per_day", + "west_coast_padd_5_imports_by_padd_of_processing_of_unfinished_oils_thousand_barrels", + "west_coast_padd_v_blending_components_av_gas_imports_for_processing_thousand_barrels_per_day", + "west_coast_padd_v_blending_components_av_gas_imports_for_processing_thousand_barrels" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumImportsByProcessingArea", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumImportsByProcessingArea", + "openapi_extra": { + "widget_config": { + "name": "Imports by Processing Area", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumImportsByProcessingArea" + } + }, + "/eia/petroleum/imports_exports_and_movements/imports_of_residual_fuel": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Imports of Residual Fuel. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.imports_of_residual_fuel(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "florida", + "massachusetts", + "minnesota", + "na", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ct", + "usa_de", + "usa_ga", + "usa_hi", + "usa_id", + "usa_il", + "usa_in", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_nh", + "usa_nj", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_va", + "usa_vt", + "usa_wi", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 313 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumImportsOfResidualFuel", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumImportsOfResidualFuel", + "openapi_extra": { + "widget_config": { + "name": "Imports of Residual Fuel", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumImportsOfResidualFuel" + } + }, + "/eia/petroleum/imports_exports_and_movements/movements_between_pad_districts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Movements by Pipeline, Tanker, Barge and Rail between PAD Districts. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.movements_between_pad_districts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_reformulated_other", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "isobutane_isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "other_biofuels", + "other_conventional_motor_gasoline", + "other_oils_for_petrochemical_feedstock_use", + "pentanes_plus", + "petrochemical_feedstocks", + "petroleum_coke_marketable", + "propane", + "propane_and_propylene", + "propylene", + "refinery_olefins", + "reformulated_gtab_gasoline_blending_components", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 740 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumMovementsBetweenPadDistricts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumMovementsBetweenPadDistricts", + "openapi_extra": { + "widget_config": { + "name": "Movements by Pipeline, Tanker, Barge and Rail between PAD Districts", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumMovementsBetweenPadDistricts" + } + }, + "/eia/petroleum/imports_exports_and_movements/movements_by_pipeline_between_pad_districts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Movements by Pipeline between PAD Districts. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.movements_by_pipeline_between_pad_districts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "finished_motor_gasoline", + "gasoline_blending_components", + "isobutane", + "isobutane_isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "other_conventional_motor_gasoline", + "pentanes_plus", + "propane", + "propane_and_propylene", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "total_petroleum_products" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 413 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumMovementsByPipelineBetweenPadDistricts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumMovementsByPipelineBetweenPadDistricts", + "openapi_extra": { + "widget_config": { + "name": "Movements by Pipeline between PAD Districts", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumMovementsByPipelineBetweenPadDistricts" + } + }, + "/eia/petroleum/imports_exports_and_movements/movements_by_rail_between_pad_districts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Movements of Crude Oil and Selected Products by Rail between PAD Districts. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.movements_by_rail_between_pad_districts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "biodiesel", + "crude_oil", + "fuel_ethanol", + "isobutane", + "normal_butane", + "petroleum_coke_marketable", + "propane", + "propylene", + "renewable_diesel_fuel" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 144 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumMovementsByRailBetweenPadDistricts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumMovementsByRailBetweenPadDistricts", + "openapi_extra": { + "widget_config": { + "name": "Movements of Crude Oil and Selected Products by Rail between PAD Districts", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumMovementsByRailBetweenPadDistricts" + } + }, + "/eia/petroleum/imports_exports_and_movements/movements_by_tanker_and_barge_between_pad_districts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Movements by Tanker and Barge between PAD Districts. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.movements_by_tanker_and_barge_between_pad_districts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_reformulated_other", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "normal_butane", + "other_biofuels", + "other_conventional_motor_gasoline", + "other_oils_for_petrochemical_feedstock_use", + "petrochemical_feedstocks", + "propane", + "propane_and_propylene", + "reformulated_gtab_gasoline_blending_components", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_5" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 545 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumMovementsByTankerAndBargeBetweenPadDistricts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumMovementsByTankerAndBargeBetweenPadDistricts", + "openapi_extra": { + "widget_config": { + "name": "Movements by Tanker and Barge between PAD Districts", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumMovementsByTankerAndBargeBetweenPadDistricts" + } + }, + "/eia/petroleum/imports_exports_and_movements/movements_of_crude_oil_and_selected_products_by_rail": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Movements of Crude Oil and Selected Products by Rail. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.movements_of_crude_oil_and_selected_products_by_rail(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "biodiesel", + "crude_oil", + "fuel_ethanol", + "isobutane", + "normal_butane", + "petroleum_coke_marketable", + "propane", + "propylene", + "renewable_diesel_fuel" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "can", + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 399 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRail", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRail", + "openapi_extra": { + "widget_config": { + "name": "Movements of Crude Oil and Selected Products by Rail", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumMovementsOfCrudeOilAndSelectedProductsByRail" + } + }, + "/eia/petroleum/imports_exports_and_movements/net_receipts_between_pad_districts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Net Receipts by Pipeline, Tanker, Barge and Rail between PAD Districts. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.net_receipts_between_pad_districts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "net_receipts_by_pipeline_tanker_barge_and_rail", + "receipts_by_pipeline_tanker_barge_and_rail", + "shipments_by_pipeline_tanker_barge_and_rail" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "isobutane_isobutylene", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "normal_butylene", + "other_biofuels", + "other_conventional_motor_gasoline", + "other_oils_for_petrochemical_feedstock_use", + "pentanes_plus", + "petrochemical_feedstocks", + "petroleum_coke_marketable", + "propane", + "propane_and_propylene", + "propylene", + "refinery_olefins", + "reformulated_gtab_gasoline_blending_components", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 914 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNetReceiptsBetweenPadDistricts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNetReceiptsBetweenPadDistricts", + "openapi_extra": { + "widget_config": { + "name": "Net Receipts by Pipeline, Tanker, Barge and Rail between PAD Districts", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNetReceiptsBetweenPadDistricts" + } + }, + "/eia/petroleum/imports_exports_and_movements/pad_district_exports_by_destination": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "PAD District Exports by Destination. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.pad_district_exports_by_destination(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "ethane", + "finished_motor_gasoline", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "kerosene", + "kerosene_type_jet_fuel", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "other_biofuels", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "petroleum_coke", + "propane", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 727 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumPadDistrictExportsByDestination", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumPadDistrictExportsByDestination", + "openapi_extra": { + "widget_config": { + "name": "PAD District Exports by Destination", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumPadDistrictExportsByDestination" + } + }, + "/eia/petroleum/imports_exports_and_movements/pad_district_imports_by_country_of_origin": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "PAD District Imports by Country of Origin. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.pad_district_imports_by_country_of_origin(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "imports", + "imports_by_padd_of_processing" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "ethane", + "ethylene", + "finished_motor_gasoline", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butylene", + "other_biofuels", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "pentanes_plus", + "petroleum_coke_marketable", + "propane", + "propylene", + "refinery_olefins", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 443 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumPadDistrictImportsByCountryOfOrigin", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumPadDistrictImportsByCountryOfOrigin", + "openapi_extra": { + "widget_config": { + "name": "PAD District Imports by Country of Origin", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumPadDistrictImportsByCountryOfOrigin" + } + }, + "/eia/petroleum/imports_exports_and_movements/us_imports_by_country_of_origin": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Imports by Country of Origin. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.us_imports_by_country_of_origin(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "ethane", + "ethylene", + "finished_motor_gasoline", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butylene", + "other_biofuels", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "pentanes_plus", + "petroleum_coke_marketable", + "propane", + "propylene", + "refinery_olefins", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 140 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumUsImportsByCountryOfOrigin", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumUsImportsByCountryOfOrigin", + "openapi_extra": { + "widget_config": { + "name": "U.S. Imports by Country of Origin", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumUsImportsByCountryOfOrigin" + } + }, + "/eia/petroleum/imports_exports_and_movements/us_net_imports_by_country": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Net Imports by Country. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.us_net_imports_by_country(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "ethane", + "ethylene", + "finished_motor_gasoline", + "fuel_ethanol", + "gasoline_blending_components", + "isobutane", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butylene", + "other_biofuels", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "pentanes_plus", + "petroleum_coke", + "propane", + "propylene", + "refinery_olefins", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 213 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumUsNetImportsByCountry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumUsNetImportsByCountry", + "openapi_extra": { + "widget_config": { + "name": "U.S. Net Imports by Country", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumUsNetImportsByCountry" + } + }, + "/eia/petroleum/imports_exports_and_movements/weekly_crude_imports_by_top_10_origins": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Preliminary Crude Imports by Top 10 Countries of Origin (ranking based on 2024 Petroleum Supply Monthly data). EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.weekly_crude_imports_by_top_10_origins(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ago", + "bra", + "can", + "cog", + "col", + "dza", + "ecu", + "gbr", + "gnq", + "irq", + "kwt", + "lby", + "mex", + "nga", + "nor", + "rus", + "sau", + "tto", + "ven" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_imports_from_algeria_of_crude_oil", + "us_imports_from_angola_of_crude_oil", + "us_imports_from_brazil_of_crude_oil", + "us_imports_from_canada_of_crude_oil", + "us_imports_from_colombia_of_crude_oil", + "us_imports_from_congo_of_crude_oil", + "us_imports_from_ecuador_of_crude_oil", + "us_imports_from_equatorial_guinea_of_crude_oil", + "us_imports_from_iraq_of_crude_oil", + "us_imports_from_kuwait_of_crude_oil", + "us_imports_from_libya_of_crude_oil", + "us_imports_from_mexico_of_crude_oil", + "us_imports_from_nigeria_of_crude_oil", + "us_imports_from_norway_of_crude_oil", + "us_imports_from_russia_of_crude_oil", + "us_imports_from_saudi_arabia_of_crude_oil", + "us_imports_from_trinidad_and_tobago_of_crude_oil", + "us_imports_from_united_kingdom_of_crude_oil", + "us_imports_from_venezuela_of_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyCrudeImportsByTop10Origins", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyCrudeImportsByTop10Origins", + "openapi_extra": { + "widget_config": { + "name": "Weekly Preliminary Crude Imports by Top 10 Countries of Origin (ranking based on 2024 Petroleum Supply Monthly data)", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyCrudeImportsByTop10Origins" + } + }, + "/eia/petroleum/imports_exports_and_movements/weekly_imports_exports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Imports & Exports. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.imports_exports_and_movements.weekly_imports_exports(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "exports", + "imports", + "imports_excluding_spr", + "imports_by_others_for_spr", + "imports_by_spr", + "net_imports" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "fuel_ethanol", + "gasoline_blending_components", + "kerosene", + "kerosene_type_jet_fuel", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "ngpls_lrgs", + "other_conventional_motor_gasoline", + "other_oils", + "other_oils_excluding_fuel_ethanol", + "propane_and_propylene", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "residual_fuel_oil", + "total_gasoline", + "total_petroleum_products" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 197 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyImportsExports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyImportsExports", + "openapi_extra": { + "widget_config": { + "name": "Weekly Imports & Exports", + "category": "EIA", + "subCategory": "Imports/Exports and Movements", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyImportsExports" + } + }, + "/eia/petroleum/prices/crude_first_purchase_prices_selected_streams": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Domestic Crude Oil First Purchase Prices for Selected Crude Streams. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.crude_first_purchase_prices_selected_streams(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ans_crude_oil", + "california_kern_river_crude_oil", + "california_midwest_sunset_crude_oil", + "louisiana_heavy_sweet_crude_oil", + "louisiana_light_sweet_crude_oil", + "mars_crude_oil", + "wti_crude_oil", + "west_texas_sour_crude_oil", + "wyoming_sweet_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "texas", + "usa_ak", + "usa_la", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alaska_north_slope_first_purchase_price", + "california_kern_river_first_purchase_price", + "california_midway_sunset_first_purchase_price", + "heavy_louisiana_sweet_first_purchase_price", + "light_louisiana_sweet_first_purchase_price", + "mars_blend_first_purchase_price", + "west_texas_intermediate_first_purchase_price", + "west_texas_sour_first_purchase_price", + "wyoming_sweet_first_purchase_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeFirstPurchasePricesSelectedStreams", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeFirstPurchasePricesSelectedStreams", + "openapi_extra": { + "widget_config": { + "name": "Domestic Crude Oil First Purchase Prices for Selected Crude Streams", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeFirstPurchasePricesSelectedStreams" + } + }, + "/eia/petroleum/prices/domestic_crude_oil_first_purchase_prices_by_api_gravity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Domestic Crude Oil First Purchase Prices by API Gravity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.domestic_crude_oil_first_purchase_prices_by_api_gravity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_gravity_20_0_percent_or_less", + "crude_gravity_20_1_to_25_0_percent", + "crude_gravity_25_1_to_30_0_percent", + "crude_gravity_30_1_to_35_0_percent", + "crude_gravity_35_1_to_40_0_percent", + "crude_gravity_40_1_percent_or_more" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_domestic_crude_oil_first_purchase_prices_with_api_gravity_20_0_degrees_or_less_dollars_per_barrel", + "us_domestic_crude_oil_first_purchase_prices_with_api_gravity_20_1_to_25_0_degrees_dollars_per_barrel", + "us_domestic_crude_oil_first_purchase_prices_with_api_gravity_25_1_to_30_0_degrees_dollars_per_barrel", + "us_domestic_crude_oil_first_purchase_prices_with_api_gravity_30_1_to_35_0_degrees_dollars_per_barrel", + "us_domestic_crude_oil_first_purchase_prices_with_api_gravity_35_1_to_40_0_degrees_dollars_per_barrel", + "us_domestic_crude_oil_first_purchase_prices_with_api_gravity_40_1_degrees_or_more_dollars_per_barrel" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumDomesticCrudeOilFirstPurchasePricesByApiGravity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumDomesticCrudeOilFirstPurchasePricesByApiGravity", + "openapi_extra": { + "widget_config": { + "name": "Domestic Crude Oil First Purchase Prices by API Gravity", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumDomesticCrudeOilFirstPurchasePricesByApiGravity" + } + }, + "/eia/petroleum/prices/domestic_crude_oil_first_purchase_prices_by_area": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Domestic Crude Oil First Purchase Prices by Area. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.domestic_crude_oil_first_purchase_prices_by_area(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ans_crude_oil", + "crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "na", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_sd", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_crude_oil_first_purchase_price", + "alaska_north_slope_first_purchase_price", + "alaska_other_crude_oil_first_purchase_price", + "arkansas_crude_oil_first_purchase_price", + "california_crude_oil_first_purchase_price", + "colorado_crude_oil_first_purchase_price", + "east_coast_crude_oil_first_purchase_price", + "federal_offshore_california_crude_oil_first_purchase_price", + "federal_offshore_us_gulf_coast_crude_oil_first_purchase", + "gulf_coast_crude_oil_first_purchase_price", + "illinois_crude_oil_first_purchase_price", + "indiana_crude_oil_first_purchase_price", + "kansas_crude_oil_first_purchase_price", + "kentucky_crude_oil_first_purchase_price", + "louisiana_crude_oil_first_purchase_price", + "michigan_crude_oil_first_purchase_price", + "midwest_crude_oil_first_purchase_price", + "mississippi_crude_oil_first_purchase_price", + "montana_crude_oil_first_purchase_price", + "nebraska_crude_oil_first_purchase_price", + "new_mexico_crude_oil_first_purchase_price", + "new_york_crude_oil_first_purchase_price", + "north_dakota_crude_oil_first_purchase_price", + "ohio_crude_oil_first_purchase_price", + "oklahoma_crude_oil_first_purchase_price", + "pennsylvania_crude_oil_first_purchase_price", + "rocky_mountain_crude_oil_first_purchase_price", + "south_dakota_crude_oil_first_purchase_price", + "texas_crude_oil_first_purchase_price", + "us_crude_oil_first_purchase_price", + "us_less_alaskan_north_slope_crude_oil_first_purchase_price", + "utah_crude_oil_first_purchase_price", + "west_coast_crude_oil_first_purchase_price", + "west_virginia_crude_oil_first_purchase_price", + "wyoming_crude_oil_first_purchase_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumDomesticCrudeOilFirstPurchasePricesByArea", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumDomesticCrudeOilFirstPurchasePricesByArea", + "openapi_extra": { + "widget_config": { + "name": "Domestic Crude Oil First Purchase Prices by Area", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumDomesticCrudeOilFirstPurchasePricesByArea" + } + }, + "/eia/petroleum/prices/fob_costs_of_imported_crude_oil_by_api_gravity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "FOB Costs of Imported Crude Oil by API Gravity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.fob_costs_of_imported_crude_oil_by_api_gravity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_gravity_20_0_percent_or_less", + "crude_gravity_20_1_to_25_0_percent", + "crude_gravity_25_1_to_30_0_percent", + "crude_gravity_30_1_to_35_0_percent", + "crude_gravity_35_1_to_40_0_percent", + "crude_gravity_40_1_to_45_0_percent", + "crude_gravity_45_1_percent_or_more" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_fob_costs_of_crude_with_api_gravity_20_0_degrees_or_less", + "us_fob_costs_of_crude_with_api_gravity_20_1_to_25_0_degrees", + "us_fob_costs_of_crude_with_api_gravity_25_1_to_30_0_degrees", + "us_fob_costs_of_crude_with_api_gravity_30_1_to_35_0_degrees", + "us_fob_costs_of_crude_with_api_gravity_35_1_to_40_0_degrees", + "us_fob_costs_of_crude_with_api_gravity_40_1_to_45_0_degrees", + "us_fob_costs_of_crude_with_api_gravity_45_1_degrees_or_more" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFobCostsOfImportedCrudeOilByApiGravity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFobCostsOfImportedCrudeOilByApiGravity", + "openapi_extra": { + "widget_config": { + "name": "F.O.B. Costs of Imported Crude Oil by API Gravity", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFobCostsOfImportedCrudeOilByApiGravity" + } + }, + "/eia/petroleum/prices/fob_costs_of_imported_crude_oil_by_area": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "FOB Costs of Imported Crude Oil by Area. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.fob_costs_of_imported_crude_oil_by_area(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ago", + "col", + "gbr", + "mex", + "na", + "nga", + "sau", + "ven" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_fob_costs_of_angola_crude_oil", + "us_fob_costs_of_colombia_crude_oil", + "us_fob_costs_of_crude_oil", + "us_fob_costs_of_mexico_crude_oil", + "us_fob_costs_of_nigeria_crude_oil", + "us_fob_costs_of_non_opec_countries_crude_oil", + "us_fob_costs_of_opec_countries_crude_oil", + "us_fob_costs_of_persian_gulf_countries_crude_oil", + "us_fob_costs_of_saudi_arabia_crude_oil", + "us_fob_costs_of_united_kingdom_crude_oil", + "us_fob_costs_of_venezuela_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFobCostsOfImportedCrudeOilByArea", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFobCostsOfImportedCrudeOilByArea", + "openapi_extra": { + "widget_config": { + "name": "F.O.B. Costs of Imported Crude Oil by Area", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFobCostsOfImportedCrudeOilByArea" + } + }, + "/eia/petroleum/prices/fob_costs_of_imported_crude_oil_for_selected_crude_streams": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "FOB Costs of Imported Crude Oil for Selected Crude Streams. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.fob_costs_of_imported_crude_oil_for_selected_crude_streams(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "angolan_cabinda_crude_oil", + "canadian_bow_river_heavy_crude_oil", + "canadian_lloydminster_crude_oil", + "canadian_light_sour_blend_crude_oil", + "ecuadorian_oriente_crude_oil", + "gabon_rabi_kouanga_crude_oil", + "iraqi_basrah_light_crude_oil", + "mexican_mayan_crude_oil", + "mexican_olmeca_crude_oil", + "nigerian_forcados_blend_crude_oil", + "nigerian_qua_iboe", + "venezuelan_furial_crude_oil", + "venezuelan_leona_crude_oil", + "venezuelan_merey" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ago", + "can", + "ecu", + "gab", + "irq", + "mex", + "nga", + "ven" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_fob_costs_of_angolan_cabinda_crude_oil", + "us_fob_costs_of_canadian_bow_river_heavy_crude_oil", + "us_fob_costs_of_canadian_lloydminster_crude_oil", + "us_fob_costs_of_canadian_light_sour_blend_crude_oil", + "us_fob_costs_of_ecuadorian_oriente_crude_oil", + "us_fob_costs_of_gabon_rabi_kouanga_crude_oil", + "us_fob_costs_of_iraqi_basrah_light_crude_oil", + "us_fob_costs_of_mexican_mayan_crude_oil", + "us_fob_costs_of_mexican_olmeca_crude_oil", + "us_fob_costs_of_nigerian_forcados_blend_crude_oil", + "us_fob_costs_of_nigerian_qua_iboe_crude_oil", + "us_fob_costs_of_venezuelan_furrial_crude_oil", + "us_fob_costs_of_venezuelan_leona_crude_oil", + "us_fob_costs_of_venezuelan_merey_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFobCostsOfImportedCrudeOilForSelectedCrudeStreams", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFobCostsOfImportedCrudeOilForSelectedCrudeStreams", + "openapi_extra": { + "widget_config": { + "name": "F.O.B. Costs of Imported Crude Oil for Selected Crude Streams", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFobCostsOfImportedCrudeOilForSelectedCrudeStreams" + } + }, + "/eia/petroleum/prices/gasoline_prices_by_formulation_grade_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Gasoline Prices by Formulation, Grade, Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.gasoline_prices_by_formulation_grade_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "bulk_sales", + "dtw_sales_price", + "rack_sales_price_by_all_sellers", + "retail_sales_by_all_sellers", + "through_company_outlets_price", + "wholesale_resale_price_by_all_sellers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_gasoline", + "conventional_premium_gasoline", + "conventional_regular_gasoline", + "gasoline_conventional_midgrade", + "gasoline_oxygenated_midgrade", + "gasoline_reformulated_midgrade", + "midgrade_gasoline", + "oxygenated_gasoline", + "oxygenated_premium_gasoline", + "oxygenated_regular_gasoline", + "premium_gasoline", + "reformulated_motor_gasoline", + "reformulated_premium_gasoline", + "reformulated_regular_gasoline", + "regular_gasoline", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumGasolinePricesByFormulationGradeSalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumGasolinePricesByFormulationGradeSalesType", + "openapi_extra": { + "widget_config": { + "name": "Gasoline Prices by Formulation, Grade, Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumGasolinePricesByFormulationGradeSalesType" + } + }, + "/eia/petroleum/prices/landed_costs_of_imported_crude_by_api_gravity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Landed Costs of Imported Crude by API Gravity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.landed_costs_of_imported_crude_by_api_gravity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_gravity_20_0_percent_or_less", + "crude_gravity_20_1_to_25_0_percent", + "crude_gravity_25_1_to_30_0_percent", + "crude_gravity_30_1_to_35_0_percent", + "crude_gravity_35_1_to_40_0_percent", + "crude_gravity_40_1_to_45_0_percent", + "crude_gravity_45_1_percent_or_more" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_landed_costs_of_crude_with_api_gravity_20_0_degrees_or", + "us_landed_costs_of_crude_with_api_gravity_20_1_to_25_0", + "us_landed_costs_of_crude_with_api_gravity_25_1_to_30_0", + "us_landed_costs_of_crude_with_api_gravity_30_1_to_35_0", + "us_landed_costs_of_crude_with_api_gravity_35_1_to_40_0", + "us_landed_costs_of_crude_with_api_gravity_40_1_to_45_0", + "us_landed_costs_of_crude_with_api_gravity_45_1_degrees_or" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumLandedCostsOfImportedCrudeByApiGravity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumLandedCostsOfImportedCrudeByApiGravity", + "openapi_extra": { + "widget_config": { + "name": "Landed Costs of Imported Crude by API Gravity", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumLandedCostsOfImportedCrudeByApiGravity" + } + }, + "/eia/petroleum/prices/landed_costs_of_imported_crude_by_area": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Landed Costs of Imported Crude by Area. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.landed_costs_of_imported_crude_by_area(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ago", + "can", + "col", + "gbr", + "mex", + "na", + "nga", + "sau", + "ven" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_landed_costs_of_angola_crude_oil", + "us_landed_costs_of_canada_crude_oil", + "us_landed_costs_of_colombia_crude_oil", + "us_landed_costs_of_crude_oil", + "us_landed_costs_of_mexico_crude_oil", + "us_landed_costs_of_nigeria_crude_oil", + "us_landed_costs_of_non_opec_countries_crude_oil", + "us_landed_costs_of_opec_countries_crude_oil", + "us_landed_costs_of_persian_gulf_countries_crude_oil", + "us_landed_costs_of_saudi_arabia_crude_oil", + "us_landed_costs_of_united_kingdom_crude_oil", + "us_landed_costs_of_venezuela_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumLandedCostsOfImportedCrudeByArea", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumLandedCostsOfImportedCrudeByArea", + "openapi_extra": { + "widget_config": { + "name": "Landed Costs of Imported Crude by Area", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumLandedCostsOfImportedCrudeByArea" + } + }, + "/eia/petroleum/prices/landed_costs_of_imported_crude_for_selected_crude_streams": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Landed Costs of Imported Crude for Selected Crude Streams. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.landed_costs_of_imported_crude_for_selected_crude_streams(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "algerian_saharan_blend_crude_oil", + "angolan_cabinda_crude_oil", + "brazilian_marlim_crude_oil", + "canadian_bow_river_heavy_crude_oil", + "canadian_lloydminster_crude_oil", + "canadian_light_sour_blend_crude_oil", + "ecuadorian_napo_crude_oil", + "ecuadorian_oriente_crude_oil", + "gabon_rabi_kouanga_crude_oil", + "iraqi_basrah_light_crude_oil", + "mexican_mayan_crude_oil", + "mexican_olmeca_crude_oil", + "nigerian_bonny_light_crude_oil", + "nigerian_forcados_blend_crude_oil", + "nigerian_qua_iboe", + "saudi_arabian_berri_crude_oil", + "saudi_arab_light_crude_oil", + "saudi_arab_medium_crude_oil", + "uk_brent_crude_oil", + "venezuelan_furial_crude_oil", + "venezuelan_leona_crude_oil", + "venezuelan_merey" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ago", + "bra", + "can", + "dza", + "ecu", + "gab", + "gbr", + "irq", + "mex", + "nga", + "sau", + "ven" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_landed_costs_of_algerian_saharan_blend_crude_oil", + "us_landed_costs_of_angolan_cabinda_crude_oil", + "us_landed_costs_of_brazilian_marlim_crude_oil", + "us_landed_costs_of_canadian_bow_river_heavy_crude_oil", + "us_landed_costs_of_canadian_lloydminster_crude_oil", + "us_landed_costs_of_canadian_light_sour_blend_crude_oil", + "us_landed_costs_of_ecuadorian_napo_crude_oil", + "us_landed_costs_of_ecuadorian_oriente_crude_oil", + "us_landed_costs_of_gabon_rabi_kouanga_crude_oil", + "us_landed_costs_of_iraqi_basrah_light_crude_oil", + "us_landed_costs_of_mexican_mayan_crude_oil", + "us_landed_costs_of_mexican_olmeca_crude_oil", + "us_landed_costs_of_nigerian_bonny_light_crude_oil", + "us_landed_costs_of_nigerian_forcados_blend_crude_oil", + "us_landed_costs_of_nigerian_qua_iboe_crude_oil", + "us_landed_costs_of_saudi_arabian_berri_crude_oil", + "us_landed_costs_of_saudi_arabian_light_crude_oil", + "us_landed_costs_of_saudi_arabian_medium_crude_oil", + "us_landed_costs_of_united_kingdom_brent_crude_oil", + "us_landed_costs_of_venezuelan_furrial_crude_oil", + "us_landed_costs_of_venezuelan_leona_crude_oil", + "us_landed_costs_of_venezuelan_merey_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumLandedCostsOfImportedCrudeForSelectedCrudeStreams", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumLandedCostsOfImportedCrudeForSelectedCrudeStreams", + "openapi_extra": { + "widget_config": { + "name": "Landed Costs of Imported Crude for Selected Crude Streams", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumLandedCostsOfImportedCrudeForSelectedCrudeStreams" + } + }, + "/eia/petroleum/prices/no2_distillate_prices_by_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "No 2 Distillate Prices by Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.no2_distillate_prices_by_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "industrial_price", + "other_end_users_by_all_sellers", + "price_delivered_to_commercial_sectors", + "residential_price_by_all_sellers", + "retail_sales_by_all_sellers", + "through_company_outlets_price", + "wholesale_resale_price_by_all_sellers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "no_2_diesel", + "no_2_diesel_high_sulfur", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "no_2_distillate" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us", + "usa_ak", + "usa_ct", + "usa_dc", + "usa_de", + "usa_id", + "usa_il", + "usa_in", + "usa_md", + "usa_me", + "usa_mi", + "usa_nh", + "usa_nj", + "usa_or", + "usa_pa", + "usa_ri", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 582 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNo2DistillatePricesBySalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNo2DistillatePricesBySalesType", + "openapi_extra": { + "widget_config": { + "name": "No. 2 Distillate Prices by Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNo2DistillatePricesBySalesType" + } + }, + "/eia/petroleum/prices/nymex_futures_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "NYMEX Futures Prices (Futures prices after April 5, 2024, are not available). EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.nymex_futures_prices(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "future_contract_1", + "future_contract_2", + "future_contract_3", + "future_contract_4" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil", + "no_2_fuel_oil_heating_oil", + "propane", + "reformulated_regular_gasoline", + "regular_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "new_york_city" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "cushing_ok_crude_oil_future_contract_1", + "cushing_ok_crude_oil_future_contract_2", + "cushing_ok_crude_oil_future_contract_3", + "cushing_ok_crude_oil_future_contract_4", + "mont_belvieu_tx_propane_future_contract_1", + "mont_belvieu_tx_propane_future_contract_2", + "mont_belvieu_tx_propane_future_contract_3", + "mont_belvieu_tx_propane_future_contract_4", + "new_york_harbor_no_2_heating_oil_future_contract_1", + "new_york_harbor_no_2_heating_oil_future_contract_2", + "new_york_harbor_no_2_heating_oil_future_contract_3", + "new_york_harbor_no_2_heating_oil_future_contract_4", + "new_york_harbor_reformulated_rbob_regular_gasoline_future_contract_1_dollars_per_gallon", + "new_york_harbor_reformulated_rbob_regular_gasoline_future_contract_2_dollars_per_gallon", + "new_york_harbor_reformulated_rbob_regular_gasoline_future_contract_3_dollars_per_gallon", + "new_york_harbor_reformulated_rbob_regular_gasoline_future_contract_4_dollars_per_gallon", + "new_york_harbor_regular_gasoline_future_contract_1", + "new_york_harbor_regular_gasoline_future_contract_2", + "new_york_harbor_regular_gasoline_future_contract_3", + "new_york_harbor_regular_gasoline_future_contract_4" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNymexFuturesPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNymexFuturesPrices", + "openapi_extra": { + "widget_config": { + "name": "NYMEX Futures Prices (Futures prices after April 5, 2024, are not available)", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNymexFuturesPrices" + } + }, + "/eia/petroleum/prices/percentages_of_total_imported_crude_oil_by_api_gravity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Percentages of Total Imported Crude Oil by API Gravity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.percentages_of_total_imported_crude_oil_by_api_gravity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_gravity_20_0_percent_or_less", + "crude_gravity_20_1_to_25_0_percent", + "crude_gravity_25_1_to_30_0_percent", + "crude_gravity_30_1_to_35_0_percent", + "crude_gravity_35_1_to_40_0_percent", + "crude_gravity_40_1_to_45_0_percent", + "crude_gravity_45_1_percent_or_more" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_percent_total_imported_by_api_gravity_of_crude_gravity_20_0_percent_or_less", + "us_percent_total_imported_by_api_gravity_of_crude_gravity_20_1_to_25_0_percent", + "us_percent_total_imported_by_api_gravity_of_crude_gravity_25_1_to_30_0_percent", + "us_percent_total_imported_by_api_gravity_of_crude_gravity_30_1_to_35_0_percent", + "us_percent_total_imported_by_api_gravity_of_crude_gravity_35_1_to_40_0_percent", + "us_percent_total_imported_by_api_gravity_of_crude_gravity_40_1_to_45_0", + "us_percent_total_imported_by_api_gravity_of_crude_gravity_45_1_or_more" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumPercentagesOfTotalImportedCrudeOilByApiGravity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumPercentagesOfTotalImportedCrudeOilByApiGravity", + "openapi_extra": { + "widget_config": { + "name": "Percentages of Total Imported Crude Oil by API Gravity", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumPercentagesOfTotalImportedCrudeOilByApiGravity" + } + }, + "/eia/petroleum/prices/propane_prices_by_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Propane (Consumer Grade) Prices by Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.propane_prices_by_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "industrial_price", + "other_end_users_by_all_sellers", + "price_delivered_to_commercial_sectors", + "residential_price_by_all_sellers", + "retail_sales_by_all_sellers", + "sales_to_petrochemical_plants_price", + "through_company_outlets_price", + "wholesale_resale_price_by_all_sellers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "central_atlantic_propane_commercial_price_by_all_sellers", + "central_atlantic_propane_industrial_price_by_all_sellers", + "central_atlantic_propane_other_end_users_price_by_all", + "central_atlantic_propane_residential_price_by_all_sellers", + "central_atlantic_propane_retail_sales_by_all_sellers", + "central_atlantic_propane_sales_to_petrochemical_plants", + "central_atlantic_propane_through_company_outlets_price_by", + "central_atlantic_propane_wholesale_resale_price_by_all", + "east_coast_propane_commercial_price_by_all_sellers", + "east_coast_propane_industrial_price_by_all_sellers", + "east_coast_propane_other_end_users_price_by_all_sellers", + "east_coast_propane_residential_price_by_all_sellers", + "east_coast_propane_retail_sales_by_all_sellers", + "east_coast_propane_sales_to_petrochemical_plants_price_by", + "east_coast_propane_through_company_outlets_price_by_all", + "east_coast_propane_wholesale_resale_price_by_all_sellers", + "gulf_coast_propane_commercial_price_by_all_sellers", + "gulf_coast_propane_industrial_price_by_all_sellers", + "gulf_coast_propane_other_end_users_price_by_all_sellers", + "gulf_coast_propane_residential_price_by_all_sellers", + "gulf_coast_propane_retail_sales_by_all_sellers", + "gulf_coast_propane_sales_to_petrochemical_plants_price_by", + "gulf_coast_propane_through_company_outlets_price_by_all", + "gulf_coast_propane_wholesale_resale_price_by_all_sellers", + "lower_atlantic_propane_commercial_price_by_all_sellers", + "lower_atlantic_propane_industrial_price_by_all_sellers", + "lower_atlantic_propane_other_end_users_price_by_all_sellers", + "lower_atlantic_propane_residential_price_by_all_sellers", + "lower_atlantic_propane_retail_sales_by_all_sellers", + "lower_atlantic_propane_sales_to_petrochemical_plants_price", + "lower_atlantic_propane_through_company_outlets_price_by_all", + "lower_atlantic_propane_wholesale_resale_price_by_all_sellers", + "midwest_propane_commercial_price_by_all_sellers", + "midwest_propane_industrial_price_by_all_sellers", + "midwest_propane_other_end_users_price_by_all_sellers", + "midwest_propane_residential_price_by_all_sellers", + "midwest_propane_retail_sales_by_all_sellers", + "midwest_propane_sales_to_petrochemical_plants_price_by_all", + "midwest_propane_through_company_outlets_price_by_all_sellers", + "midwest_propane_wholesale_resale_price_by_all_sellers", + "new_england_propane_commercial_price_by_all_sellers", + "new_england_propane_industrial_price_by_all_sellers", + "new_england_propane_other_end_users_price_by_all_sellers", + "new_england_propane_residential_price_by_all_sellers", + "new_england_propane_retail_sales_by_all_sellers", + "new_england_propane_sales_to_petrochemical_plants_price_by", + "new_england_propane_through_company_outlets_price_by_all", + "new_england_propane_wholesale_resale_price_by_all_sellers", + "rocky_mountain_propane_commercial_price_by_all_sellers", + "rocky_mountain_propane_industrial_price_by_all_sellers", + "rocky_mountain_propane_other_end_users_price_by_all_sellers", + "rocky_mountain_propane_residential_price_by_all_sellers", + "rocky_mountain_propane_retail_sales_by_all_sellers", + "rocky_mountain_propane_sales_to_petrochemical_plants_price", + "rocky_mountain_propane_through_company_outlets_price_by_all", + "rocky_mountain_propane_wholesale_resale_price_by_all_sellers", + "us_propane_commercial_price_by_all_sellers", + "us_propane_industrial_price_by_all_sellers", + "us_propane_other_end_users_price_by_all_sellers", + "us_propane_residential_price_by_all_sellers", + "us_propane_retail_sales_by_all_sellers", + "us_propane_sales_to_petrochemical_plants_price_by_all", + "us_propane_through_company_outlets_price_by_all_sellers", + "us_propane_wholesale_resale_price_by_all_sellers", + "west_coast_propane_commercial_price_by_all_sellers", + "west_coast_propane_industrial_price_by_all_sellers", + "west_coast_propane_other_end_users_price_by_all_sellers", + "west_coast_propane_residential_price_by_all_sellers", + "west_coast_propane_retail_sales_by_all_sellers", + "west_coast_propane_sales_to_petrochemical_plants_price_by", + "west_coast_propane_through_company_outlets_price_by_all", + "west_coast_propane_wholesale_resale_price_by_all_sellers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumPropanePricesBySalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumPropanePricesBySalesType", + "openapi_extra": { + "widget_config": { + "name": "Propane (Consumer Grade) Prices by Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumPropanePricesBySalesType" + } + }, + "/eia/petroleum/prices/refiner_acquisition_cost_of_crude_oil": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refiner Acquisition Cost of Crude Oil. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.refiner_acquisition_cost_of_crude_oil(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "composite_acquisition_cost", + "domestic_acquisition_cost", + "imported_acquisition_cost" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_crude_oil_composite_acquisition_cost_by_refiners", + "east_coast_crude_oil_domestic_acquisition_cost_by_refiners", + "east_coast_crude_oil_imported_acquisition_cost_by_refiners", + "gulf_coast_crude_oil_composite_acquisition_cost_by_refiners", + "gulf_coast_crude_oil_domestic_acquisition_cost_by_refiners", + "gulf_coast_crude_oil_imported_acquisition_cost_by_refiners", + "midwest_crude_oil_composite_acquisition_cost_by_refiners", + "midwest_crude_oil_domestic_acquisition_cost_by_refiners", + "midwest_crude_oil_imported_acquisition_cost_by_refiners", + "rocky_mountain_crude_oil_composite_acquisition_cost_by", + "rocky_mountain_crude_oil_domestic_acquisition_cost_by", + "rocky_mountain_crude_oil_imported_acquisition_cost_by", + "us_crude_oil_composite_acquisition_cost_by_refiners", + "us_crude_oil_domestic_acquisition_cost_by_refiners", + "us_crude_oil_imported_acquisition_cost_by_refiners", + "west_coast_crude_oil_composite_acquisition_cost_by_refiners", + "west_coast_crude_oil_domestic_acquisition_cost_by_refiners", + "west_coast_crude_oil_imported_acquisition_cost_by_refiners" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefinerAcquisitionCostOfCrudeOil", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefinerAcquisitionCostOfCrudeOil", + "openapi_extra": { + "widget_config": { + "name": "Refiner Acquisition Cost of Crude Oil", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefinerAcquisitionCostOfCrudeOil" + } + }, + "/eia/petroleum/prices/refiner_gasoline_prices_by_grade_and_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refiner Gasoline Prices by Grade and Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.refiner_gasoline_prices_by_grade_and_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "bulk_sales_by_refiners_and_gas_plants", + "dtw_sales_price_by_refiners_and_gas_plants", + "other_end_users_by_refiners_and_gas_plants", + "rack_sales_price_by_refiners_and_gas_plants", + "retail_sales_by_refiners_and_gas_plants", + "through_company_outlets_price_by_refiners_and_gas_plants", + "wholesale_resale_price_by_refiners_and_gas_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "midgrade_gasoline", + "premium_gasoline", + "regular_gasoline", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 736 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefinerGasolinePricesByGradeAndSalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefinerGasolinePricesByGradeAndSalesType", + "openapi_extra": { + "widget_config": { + "name": "Refiner Gasoline Prices by Grade and Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefinerGasolinePricesByGradeAndSalesType" + } + }, + "/eia/petroleum/prices/refiner_petroleum_product_prices_by_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refiner Petroleum Product Prices by Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.refiner_petroleum_product_prices_by_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "retail_sales_by_refiners_and_gas_plants", + "wholesale_resale_price_by_refiners_and_gas_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline", + "kerosene", + "kerosene_type_jet_fuel", + "no_1_distillate", + "no_2_diesel", + "no_2_diesel_high_sulfur", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "no_2_distillate", + "no_2_fuel_oil_heating_oil", + "no_4_distillate", + "propane", + "residual_fuel_oil", + "residual_fuel_oil_0_to_1_0_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 796 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefinerPetroleumProductPricesBySalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefinerPetroleumProductPricesBySalesType", + "openapi_extra": { + "widget_config": { + "name": "Refiner Petroleum Product Prices by Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefinerPetroleumProductPricesBySalesType" + } + }, + "/eia/petroleum/prices/residual_fuel_oil_prices_by_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Residual Fuel Oil Prices by Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.residual_fuel_oil_prices_by_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "retail_sales_by_all_sellers", + "wholesale_resale_price_by_all_sellers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "residual_fuel_oil", + "residual_fuel_oil_0_to_1_0_sulfur", + "residual_fuel_oil_greater_than_1_sulfur" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 360 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumResidualFuelOilPricesBySalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumResidualFuelOilPricesBySalesType", + "openapi_extra": { + "widget_config": { + "name": "Residual Fuel Oil Prices by Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumResidualFuelOilPricesBySalesType" + } + }, + "/eia/petroleum/prices/spot_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Spot Prices. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.spot_prices(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "carb_diesel", + "conventional_regular_gasoline", + "kerosene_type_jet_fuel", + "no_2_diesel_low_sulfur", + "no_2_fuel_oil_heating_oil", + "propane", + "reformulated_regular_gasoline", + "uk_brent_crude_oil", + "wti_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "los_angeles", + "na", + "new_york_city" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "cushing_ok_wti_spot_price_fob", + "europe_brent_spot_price_fob", + "los_angeles_reformulated_rbob_regular_gasoline_spot_price", + "los_angeles_ca_ultra_low_sulfur_carb_diesel_spot_price", + "mont_belvieu_tx_propane_spot_price_fob", + "new_york_harbor_conventional_gasoline_regular_spot_price_fob", + "new_york_harbor_no_2_heating_oil_spot_price_fob", + "new_york_harbor_ultra_low_sulfur_no_2_diesel_spot_price", + "us_gulf_coast_conventional_gasoline_regular_spot_price_fob", + "us_gulf_coast_kerosene_type_jet_fuel_spot_price_fob", + "us_gulf_coast_ultra_low_sulfur_no_2_diesel_spot_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumSpotPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumSpotPrices", + "openapi_extra": { + "widget_config": { + "name": "Spot Prices", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumSpotPrices" + } + }, + "/eia/petroleum/prices/us_refiner_gasoline_prices_by_formulation_grade_sales_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Refiner Gasoline Prices by Formulation, Grade, Sales Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.us_refiner_gasoline_prices_by_formulation_grade_sales_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "bulk_sales_by_refiners_and_gas_plants", + "dtw_sales_price_by_refiners_and_gas_plants", + "rack_sales_price_by_refiners_and_gas_plants", + "retail_sales_by_refiners_and_gas_plants", + "through_company_outlets_price_by_refiners_and_gas_plants", + "wholesale_resale_price_by_refiners_and_gas_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_gasoline", + "conventional_premium_gasoline", + "conventional_regular_gasoline", + "gasoline_conventional_midgrade", + "gasoline_oxygenated_midgrade", + "gasoline_reformulated_midgrade", + "oxygenated_gasoline", + "oxygenated_premium_gasoline", + "oxygenated_regular_gasoline", + "reformulated_motor_gasoline", + "reformulated_premium_gasoline", + "reformulated_regular_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_conventional_gasoline_bulk_sales_price_by_refiners", + "us_conventional_gasoline_dtw_sales_price_by_refiners", + "us_conventional_gasoline_midgrade_bulk_sales_price_by", + "us_conventional_gasoline_midgrade_dtw_sales_price_by", + "us_conventional_gasoline_midgrade_rack_sales_price_by", + "us_conventional_gasoline_midgrade_retail_sales_by_refiners", + "us_conventional_gasoline_midgrade_through_company_outlets", + "us_conventional_gasoline_midgrade_wholesale_resale_price_by", + "us_conventional_gasoline_premium_bulk_sales_price_by", + "us_conventional_gasoline_premium_dtw_sales_price_by_refiners", + "us_conventional_gasoline_premium_rack_sales_price_by", + "us_conventional_gasoline_premium_retail_sales_by_refiners", + "us_conventional_gasoline_premium_through_company_outlets", + "us_conventional_gasoline_premium_wholesale_resale_price_by", + "us_conventional_gasoline_rack_sales_price_by_refiners", + "us_conventional_gasoline_regular_bulk_sales_price_by", + "us_conventional_gasoline_regular_dtw_sales_price_by_refiners", + "us_conventional_gasoline_regular_rack_sales_price_by", + "us_conventional_gasoline_regular_retail_sales_by_refiners", + "us_conventional_gasoline_regular_through_company_outlets", + "us_conventional_gasoline_regular_wholesale_resale_price_by", + "us_conventional_gasoline_retail_sales_by_refiners", + "us_conventional_gasoline_through_company_outlets_price_by", + "us_conventional_gasoline_wholesale_resale_price_by_refiners", + "us_oxygenated_gasoline_bulk_sales_price_by_refiners", + "us_oxygenated_gasoline_dtw_sales_price_by_refiners", + "us_oxygenated_gasoline_midgrade_bulk_sales_price_by_refiners", + "us_oxygenated_gasoline_midgrade_dtw_sales_price_by_refiners", + "us_oxygenated_gasoline_midgrade_rack_sales_price_by_refiners", + "us_oxygenated_gasoline_midgrade_retail_sales_by_refiners", + "us_oxygenated_gasoline_midgrade_through_company_outlets", + "us_oxygenated_gasoline_midgrade_wholesale_resale_price_by", + "us_oxygenated_gasoline_premium_bulk_sales_price_by_refiners", + "us_oxygenated_gasoline_premium_dtw_sales_price_by_refiners", + "us_oxygenated_gasoline_premium_rack_sales_price_by_refiners", + "us_oxygenated_gasoline_premium_retail_sales_by_refiners", + "us_oxygenated_gasoline_premium_through_company_outlets", + "us_oxygenated_gasoline_premium_wholesale_resale_price_by", + "us_oxygenated_gasoline_rack_sales_price_by_refiners", + "us_oxygenated_gasoline_regular_bulk_sales_price_by_refiners", + "us_oxygenated_gasoline_regular_dtw_sales_price_by_refiners", + "us_oxygenated_gasoline_regular_rack_sales_price_by_refiners", + "us_oxygenated_gasoline_regular_retail_sales_by_refiners", + "us_oxygenated_gasoline_regular_through_company_outlets", + "us_oxygenated_gasoline_regular_wholesale_resale_price_by", + "us_oxygenated_gasoline_retail_sales_by_refiners", + "us_oxygenated_gasoline_through_company_outlets_price_by", + "us_oxygenated_gasoline_wholesale_resale_price_by_refiners", + "us_reformulated_gasoline_bulk_sales_price_by_refiners", + "us_reformulated_gasoline_dtw_sales_price_by_refiners", + "us_reformulated_gasoline_midgrade_bulk_sales_price_by", + "us_reformulated_gasoline_midgrade_dtw_sales_price_by", + "us_reformulated_gasoline_midgrade_rack_sales_price_by", + "us_reformulated_gasoline_midgrade_retail_sales_by_refiners", + "us_reformulated_gasoline_midgrade_through_company_outlets", + "us_reformulated_gasoline_midgrade_wholesale_resale_price_by", + "us_reformulated_gasoline_premium_bulk_sales_price_by", + "us_reformulated_gasoline_premium_dtw_sales_price_by_refiners", + "us_reformulated_gasoline_premium_rack_sales_price_by", + "us_reformulated_gasoline_premium_retail_sales_by_refiners", + "us_reformulated_gasoline_premium_through_company_outlets", + "us_reformulated_gasoline_premium_wholesale_resale_price_by", + "us_reformulated_gasoline_rack_sales_price_by_refiners", + "us_reformulated_gasoline_regular_bulk_sales_price_by", + "us_reformulated_gasoline_regular_dtw_sales_price_by_refiners", + "us_reformulated_gasoline_regular_rack_sales_price_by", + "us_reformulated_gasoline_regular_retail_sales_by_refiners", + "us_reformulated_gasoline_regular_through_company_outlets", + "us_reformulated_gasoline_regular_wholesale_resale_price_by", + "us_reformulated_gasoline_retail_sales_by_refiners", + "us_reformulated_gasoline_through_company_outlets_price_by", + "us_reformulated_gasoline_wholesale_resale_price_by_refiners" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumUsRefinerGasolinePricesByFormulationGradeSalesType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumUsRefinerGasolinePricesByFormulationGradeSalesType", + "openapi_extra": { + "widget_config": { + "name": "U.S. Refiner Gasoline Prices by Formulation, Grade, Sales Type", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumUsRefinerGasolinePricesByFormulationGradeSalesType" + } + }, + "/eia/petroleum/prices/weekly_heating_oil_and_propane_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Heating Oil and Propane Prices. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.weekly_heating_oil_and_propane_prices(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "price_delivered_to_residential_consumers", + "wholesale_resale_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "no_2_fuel_oil_heating_oil", + "propane" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "texas", + "us", + "usa_al", + "usa_ar", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_ok", + "usa_pa", + "usa_ri", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 141 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyHeatingOilAndPropanePrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyHeatingOilAndPropanePrices", + "openapi_extra": { + "widget_config": { + "name": "Weekly Heating Oil and Propane Prices", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyHeatingOilAndPropanePrices" + } + }, + "/eia/petroleum/prices/weekly_retail_gasoline_and_diesel_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Retail Gasoline and Diesel Prices. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.prices.weekly_retail_gasoline_and_diesel_prices(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_gasoline", + "conventional_premium_gasoline", + "conventional_regular_gasoline", + "gasoline_conventional_midgrade", + "gasoline_reformulated_midgrade", + "midgrade_gasoline", + "no_2_diesel", + "no_2_diesel_low_sulfur_0_15_ppm", + "no_2_diesel_low_sulfur_15_500_ppm", + "premium_gasoline", + "reformulated_motor_gasoline", + "reformulated_premium_gasoline", + "reformulated_regular_gasoline", + "regular_gasoline", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "boston", + "california", + "chicago", + "cleveland", + "colorado", + "denver", + "florida", + "houston", + "los_angeles", + "massachusetts", + "miami", + "minnesota", + "new_york", + "new_york_city", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "padd_5_except_california", + "san_francisco", + "seattle", + "texas", + "us", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 311 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyRetailGasolineAndDieselPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyRetailGasolineAndDieselPrices", + "openapi_extra": { + "widget_config": { + "name": "Weekly Retail Gasoline and Diesel Prices", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyRetailGasolineAndDieselPrices" + } + }, + "/eia/petroleum/refining_and_processing/biofuels_operable_production_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Biofuels Operable Production Capacity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.biofuels_operable_production_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "biodiesel", + "fuel_ethanol", + "renewable_diesel_and_other_biofuels" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_biodiesel_production_capacity", + "us_fuel_ethanol_production_capacity", + "us_renewable_diesel_and_other_biofuels_production_capacity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumBiofuelsOperableProductionCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumBiofuelsOperableProductionCapacity", + "openapi_extra": { + "widget_config": { + "name": "Biofuels Operable Production Capacity", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumBiofuelsOperableProductionCapacity" + } + }, + "/eia/petroleum/refining_and_processing/blender_net_input": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Blender Net Input. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.blender_net_input(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "biofuel_fuels_excluding_fuel_ethanol", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_other_gasoline_blending_components", + "fuel_ethanol", + "gasoline_blending_components", + "heavy_gas_oils", + "isobutane", + "kerosene_and_light_oils", + "liquified_petroleum_gases", + "mtbe", + "motor_gasoline_blending_components_reformulated_rbob", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "other_biofuels", + "other_liquids", + "other_oxygenates", + "oxygenates", + "oxygenates_and_renewable_fuels", + "pentanes_plus", + "reformulated_gtab_gasoline_blending_components", + "reformulated_gasoline_blending_components", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residuum", + "total_petroleum_products", + "unfinished_oils" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 840 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumBlenderNetInput", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumBlenderNetInput", + "openapi_extra": { + "widget_config": { + "name": "Blender Net Input", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumBlenderNetInput" + } + }, + "/eia/petroleum/refining_and_processing/blender_net_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Blender Net Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.blender_net_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "kerosene", + "kerosene_type_jet_fuel", + "lubricants", + "miscellaneous_petroleum_products", + "motor_gasoline_finished_conventional_ed55_and_lower", + "other_conventional_motor_gasoline", + "processing_gain", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 652 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumBlenderNetProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumBlenderNetProduction", + "openapi_extra": { + "widget_config": { + "name": "Blender Net Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumBlenderNetProduction" + } + }, + "/eia/petroleum/refining_and_processing/crude_oil_input_qualities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil Input Qualities. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.crude_oil_input_qualities(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "oil_refinery_inputs_average_sulfur_content", + "refinery_inputs_average_api_gravity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "appalachian_no_1_refinery_district_api_gravity_of_crude_oil", + "appalachian_no_1_refinery_district_sulfur_content_of_crude", + "east_coast_api_gravity_of_crude_oil_input_to_refineries", + "east_coast_sulfur_content_of_crude_oil_input_to_refineries", + "east_coast_refinery_district_api_gravity_of_crude_oil_input", + "east_coast_refinery_district_sulfur_content_of_crude_oil", + "gulf_coast_api_gravity_of_crude_oil_input_to_refineries", + "gulf_coast_sulfur_content_of_crude_oil_input_to_refineries", + "indiana_illinois_kentucky_refinery_district_api_gravity_of", + "indiana_illinois_kentucky_refinery_district_sulfur_content", + "louisiana_gulf_coast_refinery_district_api_gravity_of_crude", + "louisiana_gulf_coast_refinery_district_sulfur_content_of", + "midwest_api_gravity_of_crude_oil_input_to_refineries", + "midwest_sulfur_content_of_crude_oil_input_to_refineries", + "minnesota_wisconsin_north_and_south_dakota_refinery_district_api_gravity_weighted_average_of_crude_oil_input_to_refineries_degrees", + "minnesota_wisconsin_north_and_south_dakota_refinery_district_sulfur_content_weighted_average_of_crude_oil_input_to_refineries_percent", + "new_mexico_refinery_district_api_gravity_of_crude_oil_input", + "new_mexico_refinery_district_sulfur_content_of_crude_oil", + "north_louisiana_arkansas_refinery_district_api_gravity_of", + "north_louisiana_arkansas_refinery_district_sulfur_content", + "oklahoma_kansas_missouri_refinery_district_api_gravity_of", + "oklahoma_kansas_missouri_refinery_district_sulfur_content", + "rocky_mountains_api_gravity_of_crude_oil_input_to_refineries", + "rocky_mountains_sulfur_content_of_crude_oil_input_to", + "texas_gulf_coast_refinery_district_api_gravity_of_crude_oil", + "texas_gulf_coast_refinery_district_sulfur_content_of_crude", + "texas_inland_refinery_district_api_gravity_of_crude_oil", + "texas_inland_refinery_district_sulfur_content_of_crude_oil", + "us_api_gravity_of_crude_oil_input_to_refineries", + "us_sulfur_content_of_crude_oil_input_to_refineries", + "west_coast_api_gravity_of_crude_oil_input_to_refineries", + "west_coast_sulfur_content_of_crude_oil_input_to_refineries" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilInputQualities", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilInputQualities", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil Input Qualities", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilInputQualities" + } + }, + "/eia/petroleum/refining_and_processing/downstream_charge_capacity_of_operable_petroleum_refineries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Downstream Charge Capacity of Operable Petroleum Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.downstream_charge_capacity_of_operable_petroleum_refineries(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "catalytic_cracking_recycle", + "catalytic_hydrocracking", + "catalytic_hydrocracking_distillate", + "catalytic_hydrocracking_gas_oil", + "catalytic_hydrocracking_residual_fuel_oil", + "catalytic_reforming", + "catalytic_reforming_high_pressure", + "catalytic_reforming_low_pressure", + "downstream_charge_capacity_thermal_cracking_other_gas_oil", + "downstream_charge_capacity_thermal_cracking_visbreaking", + "downstream_charge_capacity_vacuum_distillation", + "fuels_solvent_deaspalting", + "refinery_catalytic_cracking_fresh_feed_downstream_charge", + "refinery_catalytic_hydrotreating_diesel_downstream_charge", + "refinery_catalytic_hydrotreating_distillate_downstream", + "refinery_catalytic_hydrotreating_heavy_gas_oil_downstream", + "refinery_catalytic_hydrotreating_kerosene_jet_fuel", + "refinery_catalytic_hydrotreating_naphtha_reformer_feed", + "refinery_catalytic_hydrotreating_other_distillate", + "refinery_catalytic_hydrotreating_other_oils_downstream", + "refinery_catalytic_hydrotreating_other_residual_fuel_oil", + "refinery_catalytic_hydrotreating_residual_fuel_oil", + "refinery_desulfurization_downstream_charge_capacity", + "refinery_desulfurization_gasoline_downstream_charge_capacity", + "refinery_thermal_cracking_downstream_charge_capacity", + "refinery_thermal_cracking_coking_downstream_charge_capacity", + "refinery_thermal_cracking_delayed_coking_downstream_charge", + "refinery_thermal_cracking_fluid_coking_downstream_charge" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "gum", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "pri", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_de", + "usa_ga", + "usa_hi", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wi", + "usa_wv", + "usa_wy", + "vir", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumDownstreamChargeCapacityOfOperablePetroleumRefineries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumDownstreamChargeCapacityOfOperablePetroleumRefineries", + "openapi_extra": { + "widget_config": { + "name": "Downstream Charge Capacity of Operable Petroleum Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumDownstreamChargeCapacityOfOperablePetroleumRefineries" + } + }, + "/eia/petroleum/refining_and_processing/downstream_processing_of_fresh_feed_input": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Downstream Processing of Fresh Feed Input. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.downstream_processing_of_fresh_feed_input(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "catalytic_reforming_downstream_capacity", + "downstream_catalytic_cracking", + "downstream_catalytic_hydrocracking", + "downstream_delayed_fluid_coking" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "appalachian_no_1_refining_district_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "appalachian_no_1_refining_district_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "appalachian_no_1_refining_district_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "east_coast_pad_i_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "east_coast_padd_1_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "east_coast_padd_1_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "east_coast_padd_1_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "east_coast_refining_district_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "east_coast_refining_district_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "east_coast_refining_district_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "gulf_coast_padd_3_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "gulf_coast_padd_3_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "gulf_coast_padd_3_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "gulf_coast_padd_3_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "midwest_padd_2_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "midwest_padd_2_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "midwest_padd_2_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "midwest_padd_2_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "ref_district_indiana_illinois_kentucky_downstream", + "ref_district_minnesota_wisconsin_n_and_s_dakota_downstream", + "refining_district_appalachian_no_1_downstream_processing_of", + "refining_district_east_coast_downstream_processing_of_fresh", + "refining_district_indiana_illinois_kentucky_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_indiana_illinois_kentucky_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_indiana_illinois_kentucky_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_louisiana_gulf_coast_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_louisiana_gulf_coast_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_louisiana_gulf_coast_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "refining_district_louisiana_gulf_coast_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_minnesota_wisconsin_n_and_s_dakota_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_minnesota_wisconsin_n_and_s_dakota_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_minnesota_wisconsin_n_and_s_dakota_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_new_mexico_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_new_mexico_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_new_mexico_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "refining_district_new_mexico_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_north_louisiana_arkansas_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_north_louisiana_arkansas_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_north_louisiana_arkansas_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "refining_district_north_louisiana_arkansas_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_oklahoma_kansas_missouri_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_oklahoma_kansas_missouri_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_oklahoma_kansas_missouri_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "refining_district_oklahoma_kansas_missouri_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_texas_gulf_coast_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_texas_gulf_coast_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_texas_gulf_coast_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "refining_district_texas_gulf_coast_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "refining_district_texas_inland_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "refining_district_texas_inland_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "refining_district_texas_inland_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "refining_district_texas_inland_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "rocky_mountain", + "rocky_mountain_padd_4_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "rocky_mountain_padd_4_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "rocky_mountain_padd_4_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day", + "us_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "us_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "us_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "us_downstream_processing_of_fresh_feed_input_by_delayed_and", + "west_coast_padd_5_downstream_processing_of_fresh_feed_input_by_catalytic_cracking_units_thousand_barrels_per_day", + "west_coast_padd_5_downstream_processing_of_fresh_feed_input_by_catalytic_hydrocracking_units_thousand_barrels_per_day", + "west_coast_padd_5_downstream_processing_of_fresh_feed_input_by_catalytic_reforming_units_thousand_barrels_per_day", + "west_coast_padd_5_downstream_processing_of_fresh_feed_input_by_delayed_and_fluid_coking_units_thousand_barrels_per_day" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumDownstreamProcessingOfFreshFeedInput", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumDownstreamProcessingOfFreshFeedInput", + "openapi_extra": { + "widget_config": { + "name": "Downstream Processing of Fresh Feed Input", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumDownstreamProcessingOfFreshFeedInput" + } + }, + "/eia/petroleum/refining_and_processing/feedstocks_consumed_for_production_of_biofuels": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Feedstocks Consumed for Production of Biofuels. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.feedstocks_consumed_for_production_of_biofuels(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "agriculture_and_forestry_residues", + "algae_inputs_to_biodiesel_production", + "biogas", + "canola_oil_inputs_to_biodiesel_production", + "canola_oil_for_biodiesel_plants", + "canola_oil_for_renewable_diesels_plants", + "corn", + "corn_oil_inputs_to_biodiesel_production", + "corn_oil_for_biodiesel_plants", + "corn_oil_for_renewable_diesel_plants", + "dedicated_energy_crops", + "grain_sorghum", + "municipal_solid_waste", + "other_biofuel_feedstocks", + "other_agriculture_and_forestry_products", + "other_animal_fats_inputs_to_biodiesel_production", + "other_recycled_feeds", + "other_vegetable_oil_inputs_to_biodiesel_production", + "poultry_inputs_to_biodiesel_production", + "soybean_oil_inputs_to_biodiesel_production", + "soybean_oill_biodiesel_plants", + "soybean_oill_renewable_diesel_plants", + "tallow_inputs_to_biodiesel_production", + "white_grease_inputs_to_biodiesel_production", + "yard_and_food_waste", + "yellow_grease_inputs_to_biodiesel_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "agriculture_and_forestry_residues_inputs_to_biofuels", + "biogas_inputs_to_biofuels_production", + "canola_oil_inputs_to_biofuels_production_at_biodiesel_plants", + "canola_oil_inputs_to_biofuels_production_at_renewable", + "corn_inputs_to_biofuels_production", + "corn_oil_inputs_to_biofuels_production_at_biodiesel_plants", + "corn_oil_inputs_to_biofuels_production_at_renewable_diesel", + "dedicated_energy_crops_inputs_to_biofuels_production", + "grain_sorghum_inputs_to_biofuels_production", + "municipal_solid_waste_inputs_to_biofules_production", + "oil_from_algae_inputs_to_biofuels_production", + "other_biofuel_feedstocks_inputs_to_biofuels_production", + "other_recycled_feed_inputs_to_biofuels_production", + "other_vegetable_oil_inputs_to_biofuels_production", + "other_waste_oil_fat_and_grease_inputs_to_biofuels_production", + "other_agriculture_and_forestry_products_inputs_to_biofuels", + "poultry_inputs_to_biofuels_production", + "soybean_oil_inputs_to_biofuels_production_at_biodiesel", + "soybean_oil_inputs_to_biofuels_production_at_renewable", + "tallow_inputs_to_biofuels_production", + "total_canola_oil_inputs_to_biofuels_production", + "total_corn_oil_inputs_to_biofuels_production", + "total_soybean_oil_inputs_to_biofuels_production", + "white_grease_inputs_to_biofuels_production", + "yard_and_food_waste_inputs_to_biofuels_production", + "yellow_grease_inputs_to_biofuels_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFeedstocksConsumedForProductionOfBiofuels", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFeedstocksConsumedForProductionOfBiofuels", + "openapi_extra": { + "widget_config": { + "name": "Feedstocks Consumed for Production of Biofuels", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFeedstocksConsumedForProductionOfBiofuels" + } + }, + "/eia/petroleum/refining_and_processing/fuel_consumed_at_biofuels_plants": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fuel Consumed at Biofuels Plants. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.fuel_consumed_at_biofuels_plants(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "biogas_consumed_at_biofuels_plants", + "coal_consumed_at_biofuels_plants", + "liquefied_petroleum_gases_consumed_at_biofuels_plants", + "natural_gas_consumed_at_biofuels_plants", + "natural_gas_for_hydrogen_feedstock_at_biofuels_plants", + "other_fuels_including_renewable_fuels_at_biofuels_plants", + "purchased_electricity_consumed_at_biofuels_plants", + "purchased_hydrogen_at_biofuels_plants", + "purchased_steam_consumed_at_biofuels_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_biogas_consumed_at_biofuels_plants", + "us_coal_consumed_at_biofuels_plants", + "us_liquefied_petroleum_gases_consumed_at_biofuels_plants", + "us_natural_gas_consumed_at_biofuels_plants", + "us_natural_gas_for_hydrogen_feedstock_at_biofuels_plants", + "us_other_fuels_including_renewable_fuels_at_biofuels_plants", + "us_purchased_electricity_consumed_at_biofuels_plants", + "us_purchased_hydrogen_at_biofuels_plants", + "us_purchased_steam_consumed_at_biofuels_plants" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFuelConsumedAtBiofuelsPlants", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFuelConsumedAtBiofuelsPlants", + "openapi_extra": { + "widget_config": { + "name": "Fuel Consumed at Biofuels Plants", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFuelConsumedAtBiofuelsPlants" + } + }, + "/eia/petroleum/refining_and_processing/fuel_consumed_at_refineries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fuel Consumed at Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.fuel_consumed_at_refineries(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "catalyst_petroleum_coke_consumed_at_refineries", + "coal_consumed_at_refineries", + "consumed_at_refineries", + "crude_oil_consumed_at_refineries", + "distillate_consumed_at_refineries", + "lpg_s_consumed_at_refineries", + "marketable_petroleum_coke_consumed_at_refineries", + "other_products_consumed_at_refineries", + "petroleum_coke_consumed_at_refineries", + "purchased_electricity_consumed_at_refineries", + "purchased_steam_consumed_at_refineries", + "residual_fuel_oil_consumed_at_refineries", + "still_gas_consumed_at_refineries" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_catalyst_petroleum_coke_consumed_at_refineries", + "east_coast_coal_consumed_at_refineries", + "east_coast_crude_oil_consumed_at_refineries", + "east_coast_distillate_consumed_at_refineries", + "east_coast_hgl_s_consumed_at_refineries", + "east_coast_marketable_petroleum_coke_consumed_at_refineries", + "east_coast_natural_gas_consumed_at_refineries", + "east_coast_other_products_consumed_at_refineries", + "east_coast_petroleum_coke_consumed_at_refineries", + "east_coast_purchased_electricity_consumed_at_refineries", + "east_coast_purchased_steam_consumed_at_refineries", + "east_coast_residual_fuel_oil_consumed_at_refineries", + "east_coast_still_gas_consumed_at_refineries", + "gulf_coast_catalyst_petroleum_coke_consumed_at_refineries", + "gulf_coast_coal_consumed_at_refineries", + "gulf_coast_crude_oil_consumed_at_refineries", + "gulf_coast_distillate_consumed_at_refineries", + "gulf_coast_hgl_s_consumed_at_refineries", + "gulf_coast_marketable_petroleum_coke_consumed_at_refineries", + "gulf_coast_natural_gas_consumed_at_refineries", + "gulf_coast_other_products_consumed_at_refineries", + "gulf_coast_petroleum_coke_consumed_at_refineries", + "gulf_coast_purchased_electricity_consumed_at_refineries", + "gulf_coast_purchased_steam_consumed_at_refineries", + "gulf_coast_residual_fuel_oil_consumed_at_refineries", + "gulf_coast_still_gas_consumed_at_refineries", + "midwest_catalyst_petroleum_coke_consumed_at_refineries", + "midwest_coal_consumed_at_refineries", + "midwest_crude_oil_consumed_at_refineries", + "midwest_distillate_consumed_at_refineries", + "midwest_hgl_s_consumed_at_refineries", + "midwest_marketable_petroleum_coke_consumed_at_refineries", + "midwest_natural_gas_consumed_at_refineries", + "midwest_other_products_consumed_at_refineries", + "midwest_petroleum_coke_consumed_at_refineries", + "midwest_purchased_electricity_consumed_at_refineries", + "midwest_purchased_steam_consumed_at_refineries", + "midwest_residual_fuel_oil_consumed_at_refineries", + "midwest_still_gas_consumed_at_refineries", + "rocky_mountain_catalyst_petroleum_coke_consumed_at", + "rocky_mountain_coal_consumed_at_refineries", + "rocky_mountain_crude_oil_consumed_at_refineries", + "rocky_mountain_distillate_consumed_at_refineries", + "rocky_mountain_hgl_s_consumed_at_refineries", + "rocky_mountain_marketable_petroleum_coke_consumed_at", + "rocky_mountain_natural_gas_consumed_at_refineries", + "rocky_mountain_other_products_consumed_at_refineries", + "rocky_mountain_petroleum_coke_consumed_at_refineries", + "rocky_mountain_purchased_electricity_consumed_at_refineries", + "rocky_mountain_purchased_steam_consumed_at_refineries", + "rocky_mountain_residual_fuel_oil_consumed_at_refineries", + "rocky_mountain_still_gas_consumed_at_refineries", + "us_catalyst_petroleum_coke_consumed_at_refineries", + "us_coal_consumed_at_refineries", + "us_crude_oil_consumed_at_refineries", + "us_distillate_consumed_at_refineries", + "us_hgl_s_consumed_at_refineries", + "us_marketable_petroleum_coke_consumed_at_refineries", + "us_natural_gas_consumed_at_refineries", + "us_other_products_consumed_at_refineries", + "us_petroleum_coke_consumed_at_refineries", + "us_purchased_electricity_consumed_at_refineries", + "us_purchased_steam_consumed_at_refineries", + "us_residual_fuel_oil_consumed_at_refineries", + "us_still_gas_consumed_at_refineries", + "west_coast_catalyst_petroleum_coke_consumed_at_refineries", + "west_coast_coal_consumed_at_refineries", + "west_coast_crude_oil_consumed_at_refineries", + "west_coast_distillate_consumed_at_refineries", + "west_coast_hgl_s_consumed_at_refineries", + "west_coast_marketable_petroleum_coke_consumed_at_refineries", + "west_coast_natural_gas_consumed_at_refineries", + "west_coast_other_products_consumed_at_refineries", + "west_coast_petroleum_coke_consumed_at_refineries", + "west_coast_purchased_electricity_consumed_at_refineries", + "west_coast_purchased_steam_consumed_at_refineries", + "west_coast_residual_fuel_oil_consumed_at_refineries", + "west_coast_still_gas_consumed_at_refineries" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumFuelConsumedAtRefineries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumFuelConsumedAtRefineries", + "openapi_extra": { + "widget_config": { + "name": "Fuel Consumed at Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumFuelConsumedAtRefineries" + } + }, + "/eia/petroleum/refining_and_processing/natural_gas_feedstock_for_hydrogen": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Used as Feedstock for Hydrogen Production at Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.natural_gas_feedstock_for_hydrogen(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_natural_gas_used_as_feedstock_for_hydrogen", + "gulf_coast_natural_gas_used_as_feedstock_for_hydrogen", + "midwest_natural_gas_used_as_feedstock_for_hydrogen", + "rocky_mountain_natural_gas_used_as_feedstock_for_hydrogen", + "us_natural_gas_used_as_feedstock_for_hydrogen_production", + "west_coast_natural_gas_used_as_feedstock_for_hydrogen" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNaturalGasFeedstockForHydrogen", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNaturalGasFeedstockForHydrogen", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Used as Feedstock for Hydrogen Production at Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNaturalGasFeedstockForHydrogen" + } + }, + "/eia/petroleum/refining_and_processing/natural_gas_plant_field_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Plant Field Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.natural_gas_plant_field_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "condensate_and_scrubber_oil", + "ethane", + "isobutane", + "liquified_petroleum_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "pentanes_plus", + "propane" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 284 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNaturalGasPlantFieldProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNaturalGasPlantFieldProduction", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Plant Field Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNaturalGasPlantFieldProduction" + } + }, + "/eia/petroleum/refining_and_processing/number_and_capacity_of_petroleum_refineries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Number and Capacity of Petroleum Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.number_and_capacity_of_petroleum_refineries(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "atmospheric_crude_distillation_capacity", + "atmospheric_crude_distillation_capacity_idle", + "atmospheric_crude_distillation_capacity_operating", + "catalytic_cracking_recycle", + "catalytic_hydrocracking", + "catalytic_hydrocracking_distillate", + "catalytic_hydrocracking_gas_oil", + "catalytic_hydrocracking_residual_fuel_oil", + "catalytic_reforming", + "catalytic_reforming_high_pressure", + "catalytic_reforming_low_pressure", + "downstream_charge_capacity_thermal_cracking_other_gas_oil", + "downstream_charge_capacity_thermal_cracking_visbreaking", + "downstream_charge_capacity_vacuum_distillation", + "fuels_solvent_deaspalting", + "idle_refineries", + "operable_refineries", + "operating_refineries", + "refinery_catalytic_cracking_fresh_feed_downstream_charge", + "refinery_catalytic_hydrotreating_diesel_downstream_charge", + "refinery_catalytic_hydrotreating_distillate_downstream", + "refinery_catalytic_hydrotreating_heavy_gas_oil_downstream", + "refinery_catalytic_hydrotreating_kerosene_jet_fuel", + "refinery_catalytic_hydrotreating_naphtha_reformer_feed", + "refinery_catalytic_hydrotreating_other_distillate", + "refinery_catalytic_hydrotreating_other_oils_downstream", + "refinery_catalytic_hydrotreating_other_residual_fuel_oil", + "refinery_catalytic_hydrotreating_residual_fuel_oil", + "refinery_desulfurization_downstream_charge_capacity", + "refinery_desulfurization_gasoline_downstream_charge_capacity", + "refinery_thermal_cracking_downstream_charge_capacity", + "refinery_thermal_cracking_coking_downstream_charge_capacity", + "refinery_thermal_cracking_delayed_coking_downstream_charge", + "refinery_thermal_cracking_fluid_coking_downstream_charge" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "gum", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "pri", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_de", + "usa_ga", + "usa_hi", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wi", + "usa_wv", + "usa_wy", + "vir", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNumberAndCapacityOfPetroleumRefineries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNumberAndCapacityOfPetroleumRefineries", + "openapi_extra": { + "widget_config": { + "name": "Number and Capacity of Petroleum Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNumberAndCapacityOfPetroleumRefineries" + } + }, + "/eia/petroleum/refining_and_processing/oxygenate_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Oxygenate Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.oxygenate_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "captive_plants", + "merchant_plants", + "oxygenate_plant_production", + "renewable_fuels_plant_and_oxygenate_plant_net_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "fuel_ethanol", + "mtbe", + "other_oxygenates", + "oxygenates" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_padd_1_mtbe_oxygenate_captive_facilities_production_thousand_barrels_per_day", + "east_coast_padd_1_mtbe_oxygenate_captive_facilities_production_thousand_barrels", + "east_coast_padd_1_mtbe_oxygenate_merchant_facilities_production_thousand_barrels_per_day", + "east_coast_padd_1_mtbe_oxygenate_merchant_facilities_production_thousand_barrels", + "east_coast_padd_1_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels_per_day", + "east_coast_padd_1_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels", + "east_coast_padd_1_oxygenate_plant_production_of_mtbe_thousand_barrels_per_day", + "east_coast_padd_1_oxygenate_plant_production_of_mtbe_thousand_barrels", + "gulf_coast_padd_3_biofuels_plant_net_production_of_other_oxygenates_thousand_barrels_per_day", + "gulf_coast_padd_3_biofuels_plant_net_production_of_other_oxygenates_thousand_barrels", + "gulf_coast_padd_3_mtbe_oxygenate_captive_facilities_production_thousand_barrels_per_day", + "gulf_coast_padd_3_mtbe_oxygenate_captive_facilities_production_thousand_barrels", + "gulf_coast_padd_3_mtbe_oxygenate_merchant_facilities_production_thousand_barrels_per_day", + "gulf_coast_padd_3_mtbe_oxygenate_merchant_facilities_production_thousand_barrels", + "gulf_coast_padd_3_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels_per_day", + "gulf_coast_padd_3_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels", + "gulf_coast_padd_3_oxygenate_plant_production_of_mtbe_thousand_barrels_per_day", + "gulf_coast_padd_3_oxygenate_plant_production_of_mtbe_thousand_barrels", + "gulf_coast_padd_3_oxygenate_plant_production_of_oxygenates_excluding_fuel_ethanol_thousand_barrels_per_day", + "gulf_coast_padd_3_oxygenate_plant_production_of_oxygenates_excluding_fuel_ethanol_thousand_barrels", + "midwest_padd_2_biofuels_plant_net_production_of_other_oxygenates_thousand_barrels_per_day", + "midwest_padd_2_biofuels_plant_net_production_of_other_oxygenates_thousand_barrels", + "midwest_padd_2_mtbe_oxygenate_captive_facilities_production_thousand_barrels_per_day", + "midwest_padd_2_mtbe_oxygenate_captive_facilities_production_thousand_barrels", + "midwest_padd_2_mtbe_oxygenate_merchant_facilities_production_thousand_barrels_per_day", + "midwest_padd_2_mtbe_oxygenate_merchant_facilities_production_thousand_barrels", + "midwest_padd_2_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels_per_day", + "midwest_padd_2_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels", + "midwest_padd_2_oxygenate_plant_production_of_oxygenates_excluding_fuel_ethanol_thousand_barrels_per_day", + "midwest_padd_2_oxygenate_plant_production_of_oxygenates_excluding_fuel_ethanol_thousand_barrels", + "rocky_mountain_padd_4_mtbe_oxygenate_captive_facilities_production_thousand_barrels_per_day", + "rocky_mountain_padd_4_mtbe_oxygenate_captive_facilities_production_thousand_barrels", + "rocky_mountain_padd_4_mtbe_oxygenate_merchant_facilities_production_thousand_barrels_per_day", + "rocky_mountain_padd_4_mtbe_oxygenate_merchant_facilities_production_thousand_barrels", + "rocky_mountain_padd_4_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels_per_day", + "rocky_mountain_padd_4_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels", + "us_biofuels_plant_net_production_of_other_oxygenates_thousand_barrels_per_day", + "us_biofuels_plant_net_production_of_other_oxygenates_thousand_barrels", + "us_mtbe_oxygenate_captive_facilities_production_thousand_barrels_per_day", + "us_mtbe_oxygenate_captive_facilities_production_thousand_barrels", + "us_mtbe_oxygenate_merchant_facilities_production_thousand_barrels_per_day", + "us_mtbe_oxygenate_merchant_facilities_production_thousand_barrels", + "us_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels_per_day", + "us_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels", + "us_oxygenate_plant_production_of_mtbe_thousand_barrels_per_day", + "us_oxygenate_plant_production_of_mtbe_thousand_barrels", + "us_oxygenate_plant_production_of_oxygenates_excluding_fuel_ethanol_thousand_barrels_per_day", + "us_oxygenate_plant_production_of_oxygenates_excluding_fuel_ethanol_thousand_barrels", + "west_coast_padd_5_mtbe_oxygenate_captive_facilities_production_thousand_barrels_per_day", + "west_coast_padd_5_mtbe_oxygenate_captive_facilities_production_thousand_barrels", + "west_coast_padd_5_mtbe_oxygenate_merchant_facilities_production_thousand_barrels_per_day", + "west_coast_padd_5_mtbe_oxygenate_merchant_facilities_production_thousand_barrels", + "west_coast_padd_5_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels_per_day", + "west_coast_padd_5_oxygenate_plant_production_of_fuel_ethanol_thousand_barrels" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumOxygenateProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumOxygenateProduction", + "openapi_extra": { + "widget_config": { + "name": "Oxygenate Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumOxygenateProduction" + } + }, + "/eia/petroleum/refining_and_processing/production_capacity_of_operable_petroleum_refineries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Production Capacity of Operable Petroleum Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.production_capacity_of_operable_petroleum_refineries(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "production_capacity_of_alkylates", + "production_capacity_of_aromatics", + "production_capacity_of_asphalt_and_road_oil", + "production_capacity_of_hydrogen", + "production_capacity_of_isobutane", + "production_capacity_of_isomers", + "production_capacity_of_isooctane", + "production_capacity_of_isopentane_isohexane", + "production_capacity_of_lubricants", + "production_capacity_of_marketable_coke", + "production_capacity_of_sulfur" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "gum", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "pri", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_de", + "usa_ga", + "usa_hi", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wi", + "usa_wv", + "usa_wy", + "vir", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 539 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumProductionCapacityOfOperablePetroleumRefineries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumProductionCapacityOfOperablePetroleumRefineries", + "openapi_extra": { + "widget_config": { + "name": "Production Capacity of Operable Petroleum Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumProductionCapacityOfOperablePetroleumRefineries" + } + }, + "/eia/petroleum/refining_and_processing/refinery_blender_net_input": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery & Blender Net Input. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_blender_net_input(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline_blending_components", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "biofuel_fuels_excluding_fuel_ethanol", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "heavy_gas_oils", + "hydrogen", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "kerosene_and_light_oils", + "liquified_petroleum_gases", + "mtbe", + "motor_gasoline_blending_components_reformulated_rbob", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "other_biofuels", + "other_hydrocarbons", + "other_liquids", + "other_oxygenates", + "oxygenates", + "pentanes_plus", + "reformulated_gtab_gasoline_blending_components", + "reformulated_gasoline_blending_components", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residuum", + "unfinished_oils" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryBlenderNetInput", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryBlenderNetInput", + "openapi_extra": { + "widget_config": { + "name": "Refinery & Blender Net Input", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryBlenderNetInput" + } + }, + "/eia/petroleum/refining_and_processing/refinery_blender_net_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery & Blender Net Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_blender_net_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "isobutane", + "isobutane_isobutylene", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "miscellaneous_petroleum_products", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "normal_butane", + "normal_butane_butylene", + "normal_butylene", + "other_conventional_motor_gasoline", + "other_oils_for_petrochemical_feedstock_use", + "petrochemical_feedstocks", + "petroleum_coke", + "petroleum_coke_catalyst", + "petroleum_coke_marketable", + "processing_gain", + "propane", + "propane_and_propylene", + "propylene", + "refinery_olefins", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas", + "still_gas", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryBlenderNetProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryBlenderNetProduction", + "openapi_extra": { + "widget_config": { + "name": "Refinery & Blender Net Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryBlenderNetProduction" + } + }, + "/eia/petroleum/refining_and_processing/refinery_net_input": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery Net Input. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_net_input(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "refinery_net_input", + "refinery_receipts_of_alaskan_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline_blending_components", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "biofuel_fuels_excluding_fuel_ethanol", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "heavy_gas_oils", + "hydrogen", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "kerosene_and_light_oils", + "liquified_petroleum_gases", + "mtbe", + "motor_gasoline_blending_components_reformulated_rbob", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "other_biofuels", + "other_hydrocarbons", + "other_liquids", + "other_oxygenates", + "oxygenates", + "pentanes_plus", + "reformulated_gasoline_blending_components", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residuum", + "unfinished_oils" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryNetInput", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryNetInput", + "openapi_extra": { + "widget_config": { + "name": "Refinery Net Input", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryNetInput" + } + }, + "/eia/petroleum/refining_and_processing/refinery_net_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery Net Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_net_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "commercial_kerosene_type_jet_fuel", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "isobutane", + "isobutane_isobutylene", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "military_kerosene_type_jet_fuel", + "miscellaneous_petroleum_products", + "miscellaneous_petroleum_products_for_fuel_use", + "miscellaneous_petroleum_products_for_nonfuel_use", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "naphthenic_lubricants", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "normal_butane", + "normal_butane_butylene", + "normal_butylene", + "other_conventional_motor_gasoline", + "other_oils_for_petrochemical_feedstock_use", + "paraffinic_lubricants", + "petrochemical_feedstocks", + "petroleum_coke", + "petroleum_coke_catalyst", + "petroleum_coke_marketable", + "processing_gain", + "propane", + "propane_and_propylene", + "propylene", + "refinery_olefins", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas", + "still_gas", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryNetProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryNetProduction", + "openapi_extra": { + "widget_config": { + "name": "Refinery Net Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryNetProduction" + } + }, + "/eia/petroleum/refining_and_processing/refinery_receipts_of_crude_oil_by_method_of_transportation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery Receipts of Crude Oil by Method of Transportation. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_receipts_of_crude_oil_by_method_of_transportation(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil_refinery_receipts", + "crude_oil_refinery_receipts_by_barge", + "crude_oil_refinery_receipts_by_pipeline", + "crude_oil_refinery_receipts_by_tank_car", + "crude_oil_refinery_receipts_by_tanker", + "crude_oil_refinery_receipts_by_truck", + "domestic_crude_oil_refinery_receipts", + "domestic_crude_oil_refinery_receipts_by_barge", + "domestic_crude_oil_refinery_receipts_by_pipeline", + "domestic_crude_oil_refinery_receipts_by_tank_car", + "domestic_crude_oil_refinery_receipts_by_tanker", + "domestic_crude_oil_refinery_receipts_by_truck", + "foreign_crude_oil_barge_refinery_receipts", + "foreign_crude_oil_refinery_receipts", + "foreign_crude_oil_refinery_receipts_by_pipeline", + "foreign_crude_oil_refinery_receipts_by_tank_car", + "foreign_crude_oil_refinery_receipts_by_tanker", + "foreign_crude_oil_refinery_receipts_by_truck" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 108 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryReceiptsOfCrudeOilByMethodOfTransportation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryReceiptsOfCrudeOilByMethodOfTransportation", + "openapi_extra": { + "widget_config": { + "name": "Refinery Receipts of Crude Oil by Method of Transportation", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryReceiptsOfCrudeOilByMethodOfTransportation" + } + }, + "/eia/petroleum/refining_and_processing/refinery_utilization_and_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery Utilization and Capacity. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_utilization_and_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "utilization_refinery_operable_capacity", + "refinery_idle_operable_capacity", + "refinery_net_input", + "refinery_operable_capacity", + "refinery_operating_capacity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "appalachian_no_1_refinery_district_gross_inputs_to", + "appalachian_no_1_refining_district_idle_crude_oil", + "appalachian_no_1_refining_district_operable_crude_oil", + "appalachian_no_1_refining_district_operating_crude_oil", + "appalachian_no_1_refining_district_percent_utilization_of", + "east_coast_gross_inputs_to_atmospheric_crude_oil", + "east_coast_idle_crude_oil_distillation_capacity", + "east_coast_operable_crude_oil_distillation_capacity", + "east_coast_operating_crude_oil_distillation_capacity", + "east_coast_percent_utilization_of_refinery_operable_capacity", + "east_coast_refining_district_idle_crude_oil_distillation", + "east_coast_refining_district_operable_crude_oil", + "east_coast_refining_district_operating_crude_oil", + "east_coast_refining_district_percent_utilization_of", + "gulf_coast_gross_inputs_to_refineries", + "gulf_coast_idle_crude_oil_distillation_capacity", + "gulf_coast_operable_crude_oil_distillation_capacity", + "gulf_coast_operating_crude_oil_distillation_capacity", + "gulf_coast_percent_utilization_of_refinery_operable_capacity", + "indiana_illinois_kentucky_refinery_district_gross_inputs_to", + "indiana_illinois_and_kentucky_refining_district_idle_crude", + "indiana_illinois_and_kentucky_refining_district_operable", + "indiana_illinois_and_kentucky_refining_district_operating", + "indiana_illinois_and_kentucky_refining_district_percent", + "louisiana_gulf_coast_refinery_district_gross_inputs_to", + "louisiana_gulf_coast_refining_district_idle_crude_oil", + "louisiana_gulf_coast_refining_district_operable_crude_oil", + "louisiana_gulf_coast_refining_district_operating_crude_oil", + "louisiana_gulf_coast_refining_district_percent_utilization", + "midwest_gross_inputs_to_refineries", + "midwest_idle_crude_oil_distillation_capacity", + "midwest_operable_crude_oil_distillation_capacity", + "midwest_operating_crude_oil_distillation_capacity", + "midwest_percent_utilization_of_refinery_operable_capacity", + "minnesota_wisconsin_north_and_south_dakota_refinery", + "minnesota_wisconsin_north_and_south_dakota_refining_district_idle_crude_oil_distillation_capacity_thousand_barrels_per_day", + "minnesota_wisconsin_north_and_south_dakota_refining_district_operable_crude_oil_distillation_capacity_thousand_barrels_per_calendar_day", + "minnesota_wisconsin_north_and_south_dakota_refining_district_operating_crude_oil_distillation_capacity_thousand_barrels_per_day", + "minnesota_wisconsin_north_and_south_dakota_refining_district_percent_utilization_of_refinery_operable_capacity", + "new_mexico_refining_district_idle_crude_oil_distillation", + "new_mexico_refining_district_operable_crude_oil", + "new_mexico_refining_district_operating_crude_oil", + "new_mexico_refining_district_percent_utilization_of", + "north_louisiana_and_arkansas_refining_district_idle_crude", + "north_louisiana_and_arkansas_refining_district_operable", + "north_louisiana_and_arkansas_refining_district_operating", + "north_louisiana_arkansas_refining_district_percent", + "oklahoma_kansas_missouri_refining_district_percent", + "oklahoma_kansas_and_missouri_refining_district_idle_crude", + "oklahoma_kansas_and_missouri_refining_district_operable", + "oklahoma_kansas_and_missouri_refining_district_operating", + "refining_district_east_coast_refinery_district_gross_inputs", + "refining_district_new_mexico_gross_inputs_to_atmospheric", + "refining_district_north_louisiana_arkansas_gross_inputs_to", + "refining_district_oklahoma_kansas_missouri_gross_inputs_to", + "refining_district_texas_gulf_coast_gross_inputs_to", + "rocky_mountains_gross_inputs_to_refineries", + "rocky_mountains_idle_crude_oil_distillation_capacity", + "rocky_mountains_operable_crude_oil_distillation_capacity", + "rocky_mountains_operating_crude_oil_distillation_capacity", + "rocky_mountains_percent_utilization_of_refinery_operable", + "texas_gulf_coast_refining_district_idle_crude_oil", + "texas_gulf_coast_refining_district_operable_crude_oil", + "texas_gulf_coast_refining_district_operating_crude_oil", + "texas_gulf_coast_refining_district_percent_utilization_of", + "texas_inland_refinery_district_gross_inputs_to_refineries", + "texas_inland_refining_district_idle_crude_oil_distillation", + "texas_inland_refining_district_operable_crude_oil", + "texas_inland_refining_district_operating_crude_oil", + "texas_inland_refining_district_percent_utilization_of", + "u_s_idle_crude_oil_distillation_capacity", + "u_s_operable_crude_oil_distillation_capacity", + "u_s_operating_crude_oil_distillation_capacity", + "us_gross_inputs_to_refineries", + "us_percent_utilization_of_refinery_operable_capacity", + "west_coast_gross_inputs_to_refineries", + "west_coast_idle_crude_oil_distillation_capacity", + "west_coast_operable_crude_oil_distillation_capacity", + "west_coast_operating_crude_oil_distillation_capacity", + "west_coast_percent_utilization_of_refinery_operable_capacity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryUtilizationAndCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryUtilizationAndCapacity", + "openapi_extra": { + "widget_config": { + "name": "Refinery Utilization and Capacity", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryUtilizationAndCapacity" + } + }, + "/eia/petroleum/refining_and_processing/refinery_yield": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery Yield. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.refinery_yield(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "distillate_fuel_oil", + "finished_motor_gasoline", + "kerosene", + "kerosene_type_jet_fuel", + "lubricants", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "other_oils_for_petrochemical_feedstock_use", + "petroleum_coke", + "processing_gain", + "residual_fuel_oil", + "special_naphthas", + "still_gas", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 262 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryYield", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryYield", + "openapi_extra": { + "widget_config": { + "name": "Refinery Yield", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryYield" + } + }, + "/eia/petroleum/refining_and_processing/shell_storage_capacity_at_operable_refineries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Shell Storage Capacity at Operable Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.shell_storage_capacity_at_operable_refineries(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil_shell_storage_capacity_at_refineries", + "biomass_based_diesel_fuel_shell_storage_capacity_at", + "crude_oil_shell_storage_capacity_at_refineries", + "distillate_fuel_oil_shell_storage_capacity_at_refineries", + "distillate_fuel_oil_15_ppm_sulfur_and_under_shell_storage", + "distillate_fuel_oil_greater_than_15_ppm_sulfur_to_500_ppm", + "distillate_fuel_oil_greater_than_500_ppm_sulfur_shell", + "finished_conventional_motor_gasoline_shell_storage_capacity", + "finished_motor_gasoline_shell_storage_capacity_at_refineries", + "finished_petroleum_products_shell_storage_capacity_at", + "finished_reformulated_motor_gasoline_shell_storage_capacity", + "fuel_ethanol_shell_storage_capacity_at_refineries", + "kerosene_shell_storage_capacity_at_refineries", + "kerosene_type_jet_fuel_shell_storage_capacity_at_refineries", + "liquefied_petroleum_gases_shell_storage_capacity_at", + "lubricants_shell_storage_capacity_at_refineries", + "mtbe_shell_storage_capacity_at_refineries", + "motor_gasoline_blending_components_shell_storage_capacity", + "normal_butane_butylene_shell_storage_capacity_at_refineries", + "other_liquids_shell_storage_capacity_at_refineries", + "other_oxygenates_shell_storage_capacity_at_refineries", + "other_petroleum_products_shell_storage_capacity_at", + "other_renewable_diesel_fuel_shell_storage_capacity_at", + "other_renewable_fuels_shell_storage_capacity_at_refineries", + "oxygenates_shell_storage_capacity_at_refineries", + "propane_propylene_shell_storage_capacity_at_refineries", + "residual_fuel_oil_shell_storage_capacity_at_refineries", + "shell_storage_capacity_at_refineries" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 168 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumShellStorageCapacityAtOperableRefineries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumShellStorageCapacityAtOperableRefineries", + "openapi_extra": { + "widget_config": { + "name": "Shell Storage Capacity at Operable Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumShellStorageCapacityAtOperableRefineries" + } + }, + "/eia/petroleum/refining_and_processing/weekly_blender_net_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Blender Net Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.weekly_blender_net_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "kerosene", + "kerosene_type_jet_fuel", + "motor_gasoline_finished_conventional_ed55_and_lower", + "other_conventional_motor_gasoline", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_blender_net_production_of_finished_motor_gasoline", + "gulf_coast_blender_net_production_of_finished_motor_gasoline", + "midwest_blender_net_production_of_finished_motor_gasoline", + "rocky_mountain_blender_net_production_of_finished_motor", + "us_blender_net_production_of_conventional_motor_gasoline_thousand_barrels_per_day", + "us_blender_net_production_of_conventional_motor_gasoline_with_fuel_ethanol_thousand_barrels_per_day", + "us_blender_net_production_of_distillate_fuel_oil", + "us_blender_net_production_of_distillate_fuel_oil_0_to_15", + "us_blender_net_production_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels_per_day", + "us_blender_net_production_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels_per_day", + "us_blender_net_production_of_finished_motor_gasoline", + "us_blender_net_production_of_kerosene", + "us_blender_net_production_of_kerosene_type_jet_fuel", + "us_blender_net_production_of_motor_gasoline_finished_conventional_ed55_and_lower_thousand_barrels_per_day", + "us_blender_net_production_of_motor_gasoline_finished_conventional_greater_than_ed55_thousand_barrels_per_day", + "us_blender_net_production_of_other_conventional_motor", + "us_blender_net_production_of_other_reformulated_motor", + "us_blender_net_production_of_reformulated_motor_gasoline_thousand_barrels_per_day", + "us_blender_net_production_of_reformulated_motor_gasoline_with_fuel_alcohol_thousand_barrels_per_day", + "west_coast_blender_net_production_of_finished_motor_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyBlenderNetProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyBlenderNetProduction", + "openapi_extra": { + "widget_config": { + "name": "Weekly Blender Net Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyBlenderNetProduction" + } + }, + "/eia/petroleum/refining_and_processing/weekly_ethanol_plant_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Ethanol Plant Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.weekly_ethanol_plant_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_oxygenate_plant_production_of_fuel_ethanol", + "gulf_coast_oxygenate_plant_production_of_fuel_ethanol", + "midwest_oxygenate_plant_production_of_fuel_ethanol", + "rocky_mountain_oxygenate_plant_production_of_fuel_ethanol", + "us_oxygenate_plant_production_of_fuel_ethanol", + "west_coast_oxygenate_plant_production_of_fuel_ethanol" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyEthanolPlantProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyEthanolPlantProduction", + "openapi_extra": { + "widget_config": { + "name": "Weekly Ethanol Plant Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyEthanolPlantProduction" + } + }, + "/eia/petroleum/refining_and_processing/weekly_inputs_utilization": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Inputs & Utilization. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.weekly_inputs_utilization(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "utilization_refinery_operable_capacity", + "refinery_net_input", + "refinery_operable_capacity", + "refinery_and_blender_net_input" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_other_gasoline_blending_components", + "crude_oil", + "fuel_ethanol", + "gasoline_blending_components", + "gross_inputs", + "motor_gasoline_blending_components_reformulated_rbob" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_gross_inputs_into_refineries", + "east_coast_operable_crude_oil_distillation_capacity", + "east_coast_percent_utilization_of_refinery_operable_capacity", + "east_coast_refiner_net_input_of_crude_oil", + "east_coast_padd_1_refiner_and_blender_net_input_of_conventional_cbob_gasoline_blending_components_thousand_barrels_per_day", + "east_coast_padd_1_refiner_and_blender_net_input_of_conventional_gtab_gasoline_blending_components_thousand_barrels_per_day", + "east_coast_padd_1_refiner_and_blender_net_input_of_conventional_other_gasoline_blending_components_thousand_barrels_per_day", + "east_coast_refiner_and_blender_net_input_of_fuel_ethanol", + "east_coast_refiner_and_blender_net_input_of_gasoline", + "east_coast_refiner_and_blender_net_input_of_motor_gasoline", + "gulf_coast_gross_inputs_into_refineries", + "gulf_coast_operable_crude_oil_distillation_capacity", + "gulf_coast_percent_utilization_of_refinery_operable_capacity", + "gulf_coast_refiner_net_input_of_crude_oil", + "gulf_coast_padd_3_refiner_and_blender_net_input_of_conventional_cbob_gasoline_blending_components_thousand_barrels_per_day", + "gulf_coast_padd_3_refiner_and_blender_net_input_of_conventional_gtab_gasoline_blending_components_thousand_barrels_per_day", + "gulf_coast_padd_3_refiner_and_blender_net_input_of_conventional_other_gasoline_blending_components_thousand_barrels_per_day", + "gulf_coast_refiner_and_blender_net_input_of_fuel_ethanol", + "gulf_coast_refiner_and_blender_net_input_of_gasoline", + "gulf_coast_refiner_and_blender_net_input_of_motor_gasoline", + "midwest_gross_inputs_into_refineries", + "midwest_operable_crude_oil_distillation_capacity", + "midwest_percent_utilization_of_refinery_operable_capacity", + "midwest_refiner_net_input_of_crude_oil", + "midwest_refiner_and_blender_net_input_of_conventional_cbob", + "midwest_refiner_and_blender_net_input_of_conventional_gtab", + "midwest_refiner_and_blender_net_input_of_conventional_other", + "midwest_refiner_and_blender_net_input_of_fuel_ethanol", + "midwest_refiner_and_blender_net_input_of_gasoline_blending", + "midwest_refiner_and_blender_net_input_of_motor_gasoline", + "rocky_mountain_gross_inputs_into_refineries", + "rocky_mountain_refiner_net_input_of_crude_oil", + "rocky_mountain_padd_4_refiner_and_blender_net_input_of_conventional_cbob_gasoline_blending_components_thousand_barrels_per_day", + "rocky_mountain_padd_4_refiner_and_blender_net_input_of_conventional_gtab_gasoline_blending_components_thousand_barrels_per_day", + "rocky_mountain_padd_4_refiner_and_blender_net_input_of_conventional_other_gasoline_blending_components_thousand_barrels_per_day", + "rocky_mountain_refiner_and_blender_net_input_of_fuel_ethanol", + "rocky_mountain_refiner_and_blender_net_input_of_gasoline", + "rocky_mountain_refiner_and_blender_net_input_of_motor", + "rocky_mountains_operable_crude_oil_distillation_capacity", + "rocky_mountains_percent_utilization_of_refinery_operable", + "u_s_operable_crude_oil_distillation_capacity", + "us_gross_inputs_into_refineries", + "us_percent_utilization_of_refinery_operable_capacity", + "us_refiner_net_input_of_crude_oil", + "us_refiner_and_blender_net_input_of_conventional_cbob", + "us_refiner_and_blender_net_input_of_conventional_gtab", + "us_refiner_and_blender_net_input_of_conventional_other", + "us_refiner_and_blender_net_input_of_fuel_ethanol", + "us_refiner_and_blender_net_input_of_gasoline_blending", + "us_refiner_and_blender_net_input_of_motor_gasoline_blending", + "west_coast_gross_inputs_into_refineries", + "west_coast_operable_crude_oil_distillation_capacity", + "west_coast_percent_utilization_of_refinery_operable_capacity", + "west_coast_refiner_net_input_of_crude_oil", + "west_coast_padd_5_refiner_and_blender_net_input_of_conventional_cbob_gasoline_blending_components_thousand_barrels_per_day", + "west_coast_padd_5_refiner_and_blender_net_input_of_conventional_gtab_gasoline_blending_components_thousand_barrels_per_day", + "west_coast_padd_5_refiner_and_blender_net_input_of_conventional_other_gasoline_blending_components_thousand_barrels_per_day", + "west_coast_refiner_and_blender_net_input_of_fuel_ethanol", + "west_coast_refiner_and_blender_net_input_of_gasoline", + "west_coast_refiner_and_blender_net_input_of_motor_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyInputsUtilization", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyInputsUtilization", + "openapi_extra": { + "widget_config": { + "name": "Weekly Inputs & Utilization", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyInputsUtilization" + } + }, + "/eia/petroleum/refining_and_processing/weekly_refiner_blender_net_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Refiner & Blender Net Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.weekly_refiner_blender_net_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_plants", + "production", + "refinery_and_blender_net_production", + "supply_adjustment" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_kerosene_type_jet_fuel", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "kerosene_type_jet_fuel", + "military_kerosene_type_jet_fuel", + "motor_gasoline_finished_conventional_ed55_and_lower", + "other_conventional_motor_gasoline", + "propane_and_propylene", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 112 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyRefinerBlenderNetProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyRefinerBlenderNetProduction", + "openapi_extra": { + "widget_config": { + "name": "Weekly Refiner & Blender Net Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyRefinerBlenderNetProduction" + } + }, + "/eia/petroleum/refining_and_processing/weekly_refiner_net_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Refiner Net Production. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.weekly_refiner_net_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "kerosene", + "kerosene_type_jet_fuel", + "motor_gasoline_finished_conventional_ed55_and_lower", + "other_conventional_motor_gasoline", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_coast_refiner_net_production_of_finished_motor_gasoline", + "gulf_coast_refiner_net_production_of_finished_motor_gasoline", + "midwest_refiner_net_production_of_finished_motor_gasoline", + "rocky_mountain_refiner_net_production_of_finished_motor", + "us_refiner_net_production_of_conventional_motor_gasoline_thousand_barrels_per_day", + "us_refiner_net_production_of_conventional_motor_gasoline_with_fuel_ethanol_thousand_barrels_per_day", + "us_refiner_net_production_of_distillate_fuel_oil", + "us_refiner_net_production_of_distillate_fuel_oil_0_to_15", + "us_refiner_net_production_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels_per_day", + "us_refiner_net_production_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels_per_day", + "us_refiner_net_production_of_finished_conventional_motor", + "us_refiner_net_production_of_finished_motor_gasoline", + "us_refiner_net_production_of_kerosene", + "us_refiner_net_production_of_kerosene_type_jet_fuel", + "us_refiner_net_production_of_motor_gasoline_finished", + "us_refiner_net_production_of_other_conventional_motor", + "us_refiner_net_production_of_other_reformulated_motor", + "us_refiner_net_production_of_reformulated_motor_gasoline_thousand_barrels_per_day", + "us_refiner_net_production_of_reformulated_motor_gasoline_with_fuel_alcohol_thousand_barrels_per_day", + "us_refiner_net_production_of_residual_fuel_oil", + "west_coast_refiner_net_production_of_finished_motor_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyRefinerNetProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyRefinerNetProduction", + "openapi_extra": { + "widget_config": { + "name": "Weekly Refiner Net Production", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyRefinerNetProduction" + } + }, + "/eia/petroleum/refining_and_processing/working_storage_capacity_at_operable_refineries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Working Storage Capacity at Operable Refineries. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.refining_and_processing.working_storage_capacity_at_operable_refineries(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "working_storage_capacity", + "working_storage_capacity_for_asphalt_and_road_oil", + "working_storage_capacity_for_biomass_based_diesel_fuel", + "working_storage_capacity_for_crude_oil", + "working_storage_capacity_for_distillate_fuel_oil", + "working_storage_capacity_for_distillate_fuel_oil_15_ppm", + "working_storage_capacity_for_distillate_fuel_oil_15_to_500", + "working_storage_capacity_for_distillate_fuel_oil_500_ppm", + "working_storage_capacity_for_finished_conventional_gasoline", + "working_storage_capacity_for_finished_gasoline", + "working_storage_capacity_for_finished_reformulated_gasoline", + "working_storage_capacity_for_fuel_ethanol", + "working_storage_capacity_for_gasoline_blending_components", + "working_storage_capacity_for_kerosene", + "working_storage_capacity_for_kerosene_type_jet_fuel", + "working_storage_capacity_for_liquefied_petroleum_products", + "working_storage_capacity_for_lubricants", + "working_storage_capacity_for_mtbe", + "working_storage_capacity_for_normal_butane_butylene", + "working_storage_capacity_for_other_liquids", + "working_storage_capacity_for_other_oxygenates", + "working_storage_capacity_for_other_products", + "working_storage_capacity_for_other_renewable_diesel_fuel", + "working_storage_capacity_for_other_renewable_fuels", + "working_storage_capacity_for_oxygenates", + "working_storage_capacity_for_petroleum_products", + "working_storage_capacity_for_propane_propylene", + "working_storage_capacity_for_residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 168 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWorkingStorageCapacityAtOperableRefineries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWorkingStorageCapacityAtOperableRefineries", + "openapi_extra": { + "widget_config": { + "name": "Working Storage Capacity at Operable Refineries", + "category": "EIA", + "subCategory": "Refining and Processing", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWorkingStorageCapacityAtOperableRefineries" + } + }, + "/eia/petroleum/stocks/crude_oil_stocks_at_tank_farms_pipelines": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil Stocks at Tank Farms & Pipelines. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.crude_oil_stocks_at_tank_farms_pipelines(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ending_stocks", + "stocks_at_tank_farms" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "cushing_ok_ending_stocks_of_crude_oil", + "east_coast_crude_oil_stocks_at_tank_farms_and_pipelines", + "gulf_coast_crude_oil_stocks_at_tank_farms_and_pipelines", + "midwest_crude_oil_stocks_at_tank_farms_and_pipelines", + "rocky_mountain_crude_oil_stocks_at_tank_farms_and_pipelines", + "us_crude_oil_stocks_at_tank_farms_and_pipelines", + "west_coast_crude_oil_stocks_at_tank_farms_and_pipelines" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumCrudeOilStocksAtTankFarmsPipelines", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumCrudeOilStocksAtTankFarmsPipelines", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil Stocks at Tank Farms & Pipelines", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumCrudeOilStocksAtTankFarmsPipelines" + } + }, + "/eia/petroleum/stocks/natural_gas_plant_stocks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Plant Stocks. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.natural_gas_plant_stocks(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "condensate_and_scrubber_oil", + "ethane", + "ethane_ethylene", + "isobutane", + "isobutane_isobutylene", + "liquified_petroleum_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "pentanes_plus", + "propane", + "propane_and_propylene" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 198 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumNaturalGasPlantStocks", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumNaturalGasPlantStocks", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Plant Stocks", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumNaturalGasPlantStocks" + } + }, + "/eia/petroleum/stocks/refinery_bulk_terminal_and_natural_gas_plant_stocks_by_state": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery, Bulk Terminal, and Natural Gas Plant Stocks by State. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.refinery_bulk_terminal_and_natural_gas_plant_stocks_by_state(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "gasoline_blending_components", + "kerosene", + "propane", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "residual_fuel_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 691 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryBulkTerminalAndNaturalGasPlantStocksByState", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryBulkTerminalAndNaturalGasPlantStocksByState", + "openapi_extra": { + "widget_config": { + "name": "Refinery, Bulk Terminal, and Natural Gas Plant Stocks by State", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryBulkTerminalAndNaturalGasPlantStocksByState" + } + }, + "/eia/petroleum/stocks/refinery_stocks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refinery Stocks. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.refinery_stocks(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_reformulated_other", + "fuel_ethanol", + "gasoline_blending_components", + "heavy_gas_oils", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "isobutane_isobutylene", + "isobutylene", + "kerosene", + "kerosene_and_light_oils", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "normal_butylene", + "other_biofuels", + "other_conventional_motor_gasoline", + "other_hydrocarbons", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "oxygenates", + "pentanes_plus", + "petrochemical_feedstocks", + "petroleum_coke", + "petroleum_coke_marketable", + "propane", + "propane_and_propylene", + "propylene", + "refinery_olefins", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "residuum", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumRefineryStocks", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumRefineryStocks", + "openapi_extra": { + "widget_config": { + "name": "Refinery Stocks", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumRefineryStocks" + } + }, + "/eia/petroleum/stocks/stocks_by_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Stocks by Type. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.stocks_by_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ending_stocks", + "ending_stocks_excluding_spr", + "ending_stocks_excluding_spr_and_lease", + "ending_stocks_spr", + "natural_gas_plant_stocks", + "stocks_at_bulk_terminals", + "stocks_at_leases", + "stocks_at_refineries", + "stocks_at_tank_farms", + "stocks_in_pipelines", + "stocks_in_transit_from_alaska" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "biodiesel_renewable_diesel_fuel", + "biofuel_fuels", + "biofuel_fuels_excluding_fuel_ethanol", + "condensate_and_scrubber_oil", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethane_ethylene", + "ethylene", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "finished_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "heavy_gas_oils", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "isobutane_isobutylene", + "isobutylene", + "kerosene", + "kerosene_and_light_oils", + "kerosene_type_jet_fuel", + "liquified_petroleum_gases", + "lubricants", + "mtbe", + "miscellaneous_petroleum_products", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "naphtha_for_petrochemical_feedstock_use", + "naphthas_and_lighter", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butane_butylene", + "normal_butylene", + "other_biofuels", + "other_conventional_motor_gasoline", + "other_hydrocarbons", + "other_liquids", + "other_oils_for_petrochemical_feedstock_use", + "other_oxygenates", + "oxygenates", + "pentanes_plus", + "petrochemical_feedstocks", + "petroleum_coke", + "propane", + "propane_and_propylene", + "propane_fractionated_and_ready_for_sale", + "propylene", + "propylene_nonfuel_use", + "refinery_grade_butane", + "refinery_olefins", + "reformulated_gtab_gasoline_blending_components", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "renewable_diesel_fuel", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "residuum", + "special_naphthas", + "total_petroleum_products", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumStocksByType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumStocksByType", + "openapi_extra": { + "widget_config": { + "name": "Stocks by Type", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumStocksByType" + } + }, + "/eia/petroleum/stocks/stocks_of_selected_products": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Stocks of Motor Gasoline, Distillate Fuel Oil, Residual Fuel Oil, Propane and Propylene. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.stocks_of_selected_products(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "propane_and_propylene", + "residual_fuel_oil", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "central_atlantic_padd_1b_ending_stocks_of_distillate_fuel_oil_thousand_barrels", + "central_atlantic_ending_stocks_of_distillate_fuel_oil_0_to", + "central_atlantic_padd_1b_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "central_atlantic_padd_1b_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "central_atlantic_ending_stocks_of_propane_and_propylene", + "central_atlantic_ending_stocks_of_residual_fuel_oil", + "central_atlantic_ending_stocks_of_total_gasoline", + "east_coast_ending_stocks_of_distillate_fuel_oil", + "east_coast_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm", + "east_coast_padd_1_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "east_coast_padd_1_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "east_coast_ending_stocks_of_propane_and_propylene", + "east_coast_ending_stocks_of_residual_fuel_oil", + "east_coast_ending_stocks_of_total_gasoline", + "gulf_coast_ending_stocks_of_distillate_fuel_oil", + "gulf_coast_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm", + "gulf_coast_padd_3_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "gulf_coast_padd_3_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "gulf_coast_ending_stocks_of_propane_and_propylene", + "gulf_coast_ending_stocks_of_residual_fuel_oil", + "gulf_coast_ending_stocks_of_total_gasoline", + "lower_atlantic_ending_stocks_of_distillate_fuel_oil", + "lower_atlantic_ending_stocks_of_distillate_fuel_oil_0_to_15", + "lower_atlantic_padd_1c_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "lower_atlantic_padd_1c_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "lower_atlantic_ending_stocks_of_propane_and_propylene", + "lower_atlantic_ending_stocks_of_residual_fuel_oil", + "lower_atlantic_ending_stocks_of_total_gasoline", + "midwest_ending_stocks_of_distillate_fuel_oil", + "midwest_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm", + "midwest_padd_2_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "midwest_padd_2_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "midwest_ending_stocks_of_propane_and_propylene", + "midwest_ending_stocks_of_residual_fuel_oil", + "midwest_ending_stocks_of_total_gasoline", + "new_england_ending_stocks_of_distillate_fuel_oil_0_to_15", + "new_england_padd_1a_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "new_england_ending_stocks_of_distillate_fuel_oil", + "new_england_padd_1a_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "new_england_ending_stocks_of_propane_and_propylene", + "new_england_ending_stocks_of_residual_fuel_oil", + "new_england_ending_stocks_of_total_gasoline", + "rocky_mountain_ending_stocks_of_distillate_fuel_oil", + "rocky_mountain_ending_stocks_of_distillate_fuel_oil_0_to_15", + "rocky_mountain_padd_4_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "rocky_mountain_padd_4_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "rocky_mountain_ending_stocks_of_propane_and_propylene", + "rocky_mountain_ending_stocks_of_residual_fuel_oil", + "rocky_mountain_ending_stocks_of_total_gasoline", + "us_ending_stocks_of_distillate_fuel_oil", + "us_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm_sulfur", + "us_ending_stocks_of_distillate_fuel_oil_greater_than_500", + "us_ending_stocks_of_distillate_fuel_oil_greater_than_15_to", + "us_ending_stocks_of_propane_and_propylene", + "us_ending_stocks_of_residual_fuel_oil", + "us_ending_stocks_of_total_gasoline", + "west_coast_ending_stocks_of_distillate_fuel_oil", + "west_coast_ending_stocks_of_distillate_fuel_oil_0_to_15_ppm", + "west_coast_padd_5_ending_stocks_of_distillate_fuel_oil_greater_than_500_ppm_sulfur_thousand_barrels", + "west_coast_padd_5_ending_stocks_of_distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur_thousand_barrels", + "west_coast_ending_stocks_of_propane_and_propylene", + "west_coast_ending_stocks_of_residual_fuel_oil", + "west_coast_ending_stocks_of_total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumStocksOfSelectedProducts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumStocksOfSelectedProducts", + "openapi_extra": { + "widget_config": { + "name": "Stocks of Motor Gasoline, Distillate Fuel Oil, Residual Fuel Oil, Propane and Propylene", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumStocksOfSelectedProducts" + } + }, + "/eia/petroleum/stocks/weekly_stocks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Stocks. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.stocks.weekly_stocks(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ending_stocks", + "ending_stocks_excluding_propylene_at_terminal", + "ending_stocks_excluding_spr", + "ending_stocks_excluding_spr_and_lease", + "ending_stocks_spr", + "stocks_at_bulk_terminals", + "stocks_in_transit_from_alaska" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "fuel_ethanol", + "gasoline_blending_components", + "kerosene", + "kerosene_type_jet_fuel", + "motor_gasoline_blending_components_reformulated_rbob", + "ngpls_lrgs", + "other_conventional_motor_gasoline", + "other_oils", + "propane_and_propylene", + "propane_fractionated_and_ready_for_sale", + "propylene_nonfuel_use", + "reformulated_gtab_gasoline_blending_components", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "residual_fuel_oil", + "total_gasoline", + "unfinished_oils" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 205 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklyStocks", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklyStocks", + "openapi_extra": { + "widget_config": { + "name": "Weekly Stocks", + "category": "EIA", + "subCategory": "Stocks", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklyStocks" + } + }, + "/eia/petroleum/summary/prices_sales_volumes_stocks_by_state": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Prices, Sales Volumes & Stocks by State. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.summary.prices_sales_volumes_stocks_by_state(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_sales_deliveries", + "residential_price_by_all_sellers", + "retail_sales_by_all_sellers", + "retail_sales_by_refiners_and_gas_plants", + "stocks_at_refineries_bulk_terminals_and_natural_gas_plants", + "through_company_outlets_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aviation_gasoline", + "conventional_motor_gasoline", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "finished_motor_gasoline", + "gasoline_blending_components", + "kerosene", + "kerosene_type_jet_fuel", + "midgrade_gasoline", + "no_1_distillate", + "no_2_diesel", + "no_2_distillate", + "no_2_fuel_oil_heating_oil", + "no_4_distillate", + "premium_gasoline", + "propane", + "reformulated_motor_gasoline", + "regular_gasoline", + "residual_fuel_oil", + "total_gasoline" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumPricesSalesVolumesStocksByState", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumPricesSalesVolumesStocksByState", + "openapi_extra": { + "widget_config": { + "name": "Prices, Sales Volumes & Stocks by State", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumPricesSalesVolumesStocksByState" + } + }, + "/eia/petroleum/summary/supply_and_disposition": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Supply and Disposition. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.summary.supply_and_disposition(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ending_stocks", + "exports", + "field_production", + "imports", + "net_receipts_by_pipeline_tanker_barge_and_rail", + "product_supplied", + "refinery_and_blender_net_input", + "refinery_and_blender_net_production", + "renewable_fuels_plant_and_oxygenate_plant_net_production", + "stock_change", + "supply_adjustment", + "transfers_to_crude_oil_supply" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "aviation_gasoline", + "aviation_gasoline_blending_components", + "biodiesel", + "biofuel_fuels", + "biofuel_fuels_excluding_fuel_ethanol", + "condensate_and_scrubber_oil", + "conventional_gasoline_blending_components", + "conventional_motor_gasoline", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "ethane", + "ethylene", + "finished_motor_gasoline", + "finished_petroleum_products", + "fuel_ethanol", + "gasoline_blending_components", + "hydrogen", + "hydrogen_oxygenates_renewables_fuels_and_other_hydrocarbons", + "isobutane", + "isobutylene", + "kerosene", + "kerosene_type_jet_fuel", + "lubricants", + "miscellaneous_petroleum_products", + "naphtha_for_petrochemical_feedstock_use", + "natural_gas_liquids_and_liquid_refinery_gases", + "natural_gas_plant_liquids", + "natural_gasoline", + "normal_butane", + "normal_butylene", + "other_biofuels", + "other_hydrocarbons", + "other_liquids", + "other_oils_for_petrochemical_feedstock_use", + "oxygenates", + "petrochemical_feedstocks", + "petroleum_coke", + "petroleum_coke_catalyst", + "petroleum_coke_marketable", + "propane", + "propylene", + "refinery_olefins", + "reformulated_gasoline_blending_components", + "reformulated_motor_gasoline", + "renewable_diesel_fuel", + "residual_fuel_oil", + "residual_fuel_oil_0_31_to_1_00_sulfur", + "residual_fuel_oil_greater_than_1_sulfur", + "residual_fuel_oil_less_than_0_31_sulfur", + "special_naphthas", + "still_gas", + "unfinished_oils", + "waxes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumSupplyAndDisposition", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumSupplyAndDisposition", + "openapi_extra": { + "widget_config": { + "name": "Supply and Disposition", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumSupplyAndDisposition" + } + }, + "/eia/petroleum/summary/us_biodiesel_production_capacity_sales_and_stocks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Biodiesel Production, Capacity, Sales, and Stocks - discontinued. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.summary.us_biodiesel_production_capacity_sales_and_stocks(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "biodiesel_production", + "biodiesel_production_capacity", + "ending_stocks", + "number_of_producers_for_biodiesel_production", + "sales_of_b100_included_biodiesel_blends", + "sales_of_biodiesel_b100", + "stock_change" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "padd_1", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wi", + "usa_wv", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 104 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumUsBiodieselProductionCapacitySalesAndStocks", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumUsBiodieselProductionCapacitySalesAndStocks", + "openapi_extra": { + "widget_config": { + "name": "U.S. Biodiesel Production, Capacity, Sales, and Stocks - discontinued", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumUsBiodieselProductionCapacitySalesAndStocks" + } + }, + "/eia/petroleum/summary/us_crude_oil_supply_disposition": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Crude Oil Supply & Disposition. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.summary.us_crude_oil_supply_disposition(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "days_of_petroleum_net_imports", + "ending_stocks", + "ending_stocks_excluding_spr", + "ending_stocks_spr", + "exports", + "field_production", + "imports", + "imports_excluding_spr", + "imports_spr", + "imports_by_others_for_spr", + "percent_of_crude_oil_stocks", + "percent_of_total_petroleum_stocks", + "product_supplied", + "refinery_and_blender_net_input", + "spr_receipts_detail_domestic", + "spr_receipts_detail_receipts", + "spr_stock_change", + "stock_change", + "stock_change_excluding_spr", + "stocks_at_leases", + "stocks_at_refineries", + "stocks_at_tank_farms", + "stocks_in_transit_from_alaska", + "supply_adjustment" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "us", + "usa_ak" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alaska_field_production_of_crude_oil", + "cushing_ok_ending_stocks_of_crude_oil", + "lower_48_states_field_production_of_crude_oil", + "us_crude_oil_imports_excluding_spr", + "us_crude_oil_imports_for_spr_by_others_from_all_countries", + "us_crude_oil_spr_imports_from_all_countries", + "us_crude_oil_spr_stock_change", + "us_crude_oil_stock_change", + "us_crude_oil_stock_change_excluding_spr", + "us_crude_oil_stocks_at_leases", + "us_crude_oil_stocks_at_refineries", + "us_crude_oil_stocks_at_tank_farms_and_pipelines", + "us_crude_oil_stocks_in_transit_from_alaska", + "us_crude_oil_spr_receipts_detail_domestic", + "us_crude_oil_spr_receipts_detail_receipts", + "us_ending_stocks_excluding_spr_of_crude_oil", + "us_ending_stocks_of_crude_oil", + "us_ending_stocks_of_crude_oil_in_spr", + "us_exports_of_crude_oil", + "us_field_production_of_crude_oil", + "us_imports_of_crude_oil", + "us_percent_of_crude_oil_stocks_held_in_spr", + "us_percent_of_total_petroleum_stocks_held_in_spr", + "us_product_supplied_of_crude_oil", + "us_refinery_and_blender_net_input_of_crude_oil", + "us_spr_stocks_as_days_of_supply_of_total_petroleum_net", + "us_supply_adjustment_of_crude_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumUsCrudeOilSupplyDisposition", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumUsCrudeOilSupplyDisposition", + "openapi_extra": { + "widget_config": { + "name": "U.S. Crude Oil Supply & Disposition", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumUsCrudeOilSupplyDisposition" + } + }, + "/eia/petroleum/summary/weekly_supply_estimates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Supply Estimates. EIA petroleum gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum.summary.weekly_supply_estimates(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "utilization_refinery_operable_capacity", + "all_plants", + "days_of_supply", + "ending_stocks", + "ending_stocks_excluding_propylene_at_terminal", + "ending_stocks_excluding_spr", + "ending_stocks_excluding_spr_and_lease", + "ending_stocks_spr", + "exports", + "field_production", + "imports", + "imports_excluding_spr", + "imports_by_others_for_spr", + "imports_by_spr", + "net_imports", + "oxygenate_plant_production", + "product_supplied", + "production", + "refinery_net_input", + "refinery_operable_capacity", + "refinery_and_blender_net_input", + "refinery_and_blender_net_production", + "stocks_at_bulk_terminals", + "stocks_in_transit_from_alaska", + "supply_adjustment" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "asphalt_and_road_oil", + "commercial_kerosene_type_jet_fuel", + "conventional_cbob_gasoline_blending_components", + "conventional_gtab_gasoline_blending_components", + "conventional_motor_gasoline", + "conventional_motor_gasoline_with_alcohol", + "conventional_other_gasoline_blending_components", + "crude_oil", + "crude_oil_and_petroleum_products", + "distillate_fuel_oil", + "distillate_fuel_oil_0_to_15_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_15_to_500_ppm_sulfur", + "distillate_fuel_oil_greater_than_2000_ppm_sulfur", + "distillate_fuel_oil_greater_than_500_to_2000_ppm_sulfur", + "finished_motor_gasoline", + "finished_motor_gasoline_conventional_55", + "finished_motor_gasoline_reformulated_other", + "fuel_ethanol", + "gasoline_blending_components", + "gross_inputs", + "kerosene", + "kerosene_type_jet_fuel", + "military_kerosene_type_jet_fuel", + "motor_gasoline_blending_components_reformulated_rbob", + "motor_gasoline_finished_conventional_ed55_and_lower", + "ngpls_lrgs", + "other_conventional_motor_gasoline", + "other_oils", + "other_oils_excluding_fuel_ethanol", + "propane_and_propylene", + "propane_fractionated_and_ready_for_sale", + "propylene_nonfuel_use", + "reformulated_motor_gasoline", + "reformulated_motor_gasoline_with_alcohol", + "reformulated_motor_gasoline_non_oxygentated", + "reformulated_rbob_with_alcohol_gasoline_blending_components", + "reformulated_rbob_with_ether_gasoline_blending_components", + "residual_fuel_oil", + "total_gasoline", + "total_petroleum_products", + "unfinished_oils" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "padd_1", + "padd_1a", + "padd_1b", + "padd_1c", + "padd_2", + "padd_3", + "padd_4", + "padd_5", + "us", + "usa_ak" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 608 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaPetroleumWeeklySupplyEstimates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaPetroleumWeeklySupplyEstimates", + "openapi_extra": { + "widget_config": { + "name": "Weekly Supply Estimates", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaPetroleumWeeklySupplyEstimates" + } + }, + "/eia/natural_gas/consumption_end_use/heat_content_of_natural_gas_consumed": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Heat Content of Natural Gas Consumed. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.consumption_end_use.heat_content_of_natural_gas_consumed(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_heat_content_of_natural_gas_deliveries_to_consumers", + "alaska_heat_content_of_natural_gas_deliveries_to_consumers", + "arizona_heat_content_of_natural_gas_deliveries_to_consumers", + "arkansas_heat_content_of_natural_gas_deliveries_to_consumers", + "california_heat_content_of_natural_gas_deliveries_to", + "colorado_heat_content_of_natural_gas_deliveries_to_consumers", + "connecticut_heat_content_of_natural_gas_deliveries_to", + "delaware_heat_content_of_natural_gas_deliveries_to_consumers", + "district_of_columbia_heat_content_of_natural_gas_deliveries", + "florida_heat_content_of_natural_gas_deliveries_to_consumers", + "georgia_heat_content_of_natural_gas_deliveries_to_consumers", + "hawaii_heat_content_of_natural_gas_deliveries_to_consumers", + "idaho_heat_content_of_natural_gas_deliveries_to_consumers", + "illinois_heat_content_of_natural_gas_deliveries_to_consumers", + "indiana_heat_content_of_natural_gas_deliveries_to_consumers", + "iowa_heat_content_of_natural_gas_deliveries_to_consumers", + "kansas_heat_content_of_natural_gas_deliveries_to_consumers", + "kentucky_heat_content_of_natural_gas_deliveries_to_consumers", + "louisiana_heat_content_of_natural_gas_deliveries_to", + "maine_heat_content_of_natural_gas_deliveries_to_consumers", + "maryland_heat_content_of_natural_gas_deliveries_to_consumers", + "massachusetts_heat_content_of_natural_gas_deliveries_to", + "michigan_heat_content_of_natural_gas_deliveries_to_consumers", + "minnesota_heat_content_of_natural_gas_deliveries_to", + "mississippi_heat_content_of_natural_gas_deliveries_to", + "missouri_heat_content_of_natural_gas_deliveries_to_consumers", + "montana_heat_content_of_natural_gas_deliveries_to_consumers", + "nebraska_heat_content_of_natural_gas_deliveries_to_consumers", + "nevada_heat_content_of_natural_gas_deliveries_to_consumers", + "new_hampshire_heat_content_of_natural_gas_deliveries_to", + "new_jersey_heat_content_of_natural_gas_deliveries_to", + "new_mexico_heat_content_of_natural_gas_deliveries_to", + "new_york_heat_content_of_natural_gas_deliveries_to_consumers", + "north_carolina_heat_content_of_natural_gas_deliveries_to", + "north_dakota_heat_content_of_natural_gas_deliveries_to", + "ohio_heat_content_of_natural_gas_deliveries_to_consumers", + "oklahoma_heat_content_of_natural_gas_deliveries_to_consumers", + "oregon_heat_content_of_natural_gas_deliveries_to_consumers", + "pennsylvania_heat_content_of_natural_gas_deliveries_to", + "rhode_island_heat_content_of_natural_gas_deliveries_to", + "south_carolina_heat_content_of_natural_gas_deliveries_to", + "south_dakota_heat_content_of_natural_gas_deliveries_to", + "tennessee_heat_content_of_natural_gas_deliveries_to", + "texas_heat_content_of_natural_gas_deliveries_to_consumers", + "us_heat_content_of_natural_gas_deliveries_to_consumers", + "utah_heat_content_of_natural_gas_deliveries_to_consumers", + "vermont_heat_content_of_natural_gas_deliveries_to_consumers", + "virginia_heat_content_of_natural_gas_deliveries_to_consumers", + "washington_heat_content_of_natural_gas_deliveries_to", + "west_virginia_heat_content_of_natural_gas_deliveries_to", + "wisconsin_heat_content_of_natural_gas_deliveries_to", + "wyoming_heat_content_of_natural_gas_deliveries_to_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasHeatContentOfNaturalGasConsumed", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasHeatContentOfNaturalGasConsumed", + "openapi_extra": { + "widget_config": { + "name": "Heat Content of Natural Gas Consumed", + "category": "EIA", + "subCategory": "Consumption / End Use", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasHeatContentOfNaturalGasConsumed" + } + }, + "/eia/natural_gas/consumption_end_use/natural_gas_consumption_by_end_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Consumption by End Use. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.consumption_end_use.natural_gas_consumption_by_end_use(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_consumption", + "delivered_to_consumers", + "electric_power_consumption", + "industrial_consumption", + "lease_and_plant_fuel_consumption", + "pipeline_fuel_consumption", + "residential_consumption", + "total_consumption", + "vehicle_fuel_consumption" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 315 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasConsumptionByEndUse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasConsumptionByEndUse", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Consumption by End Use", + "category": "EIA", + "subCategory": "Consumption / End Use", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasConsumptionByEndUse" + } + }, + "/eia/natural_gas/consumption_end_use/natural_gas_delivered_for_the_account_of_others": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Delivered for the Account of Others. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.consumption_end_use.natural_gas_delivered_for_the_account_of_others(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "total_residential_consumers_deliveries", + "of_total_commercial_delivered_for_the_account_of_others", + "of_total_industrial_delivered_for_the_account_of_others", + "delivered_to_commercial_consumers_for_the_account_of_others", + "delivered_to_industrial_consumers_for_the_account_of_others", + "residential_transported" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 269 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasDeliveredForTheAccountOfOthers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasDeliveredForTheAccountOfOthers", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Delivered for the Account of Others", + "category": "EIA", + "subCategory": "Consumption / End Use", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasDeliveredForTheAccountOfOthers" + } + }, + "/eia/natural_gas/consumption_end_use/number_of_natural_gas_consumers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Number of Natural Gas Consumers. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.consumption_end_use.number_of_natural_gas_consumers(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_annual_consumption_per_commercial_consumer", + "average_annual_consumption_per_industrial_consumer", + "number_of_commercial_consumers", + "number_of_commercial_consumers_sales", + "number_of_commercial_consumers_transported", + "number_of_industrial_consumers", + "number_of_industrial_consumers_sales", + "number_of_industrial_consumers_transported", + "number_of_residential_consumers", + "number_of_residential_consumers_sales", + "number_of_residential_consumers_transported" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 548 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNumberOfNaturalGasConsumers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNumberOfNaturalGasConsumers", + "openapi_extra": { + "widget_config": { + "name": "Number of Natural Gas Consumers", + "category": "EIA", + "subCategory": "Consumption / End Use", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNumberOfNaturalGasConsumers" + } + }, + "/eia/natural_gas/consumption_end_use/share_of_total_us_natural_gas_delivered_to_consumers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Share of Total US Natural Gas Delivered to Consumers. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.consumption_end_use.share_of_total_us_natural_gas_delivered_to_consumers(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "total_commercial_deliveries", + "total_industrial_deliveries", + "of_total_electric_utility_deliveries", + "of_total_residential_deliveries", + "of_total_vehicle_fuel_deliveries" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 260 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasShareOfTotalUsNaturalGasDeliveredToConsumers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasShareOfTotalUsNaturalGasDeliveredToConsumers", + "openapi_extra": { + "widget_config": { + "name": "Share of Total U.S. Natural Gas Delivered to Consumers", + "category": "EIA", + "subCategory": "Consumption / End Use", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasShareOfTotalUsNaturalGasDeliveredToConsumers" + } + }, + "/eia/natural_gas/exploration_and_reserves/associated_dissolved_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Associated-Dissolved Natural Gas Proved Reserves, Wet After Lease Separation. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.associated_dissolved_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "associated_dissolved_production_from_reserves", + "associated_dissolved_proved_reserves", + "associated_dissolved_reserves_acquisitions", + "associated_dissolved_reserves_adjustments", + "associated_dissolved_reserves_extensions", + "associated_dissolved_reserves_extensions_and_discoveries", + "associated_dissolved_reserves_new_field_discoveries", + "associated_dissolved_reserves_new_reservoir_discoveries_in", + "associated_dissolved_reserves_revision_decreases", + "associated_dissolved_reserves_revision_increases", + "associated_dissolved_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 572 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasAssociatedDissolvedProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasAssociatedDissolvedProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Associated-Dissolved Natural Gas Proved Reserves, Wet After Lease Separation", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasAssociatedDissolvedProvedReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/average_depth_of_crude_oil_and_natural_gas_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Average Depth of Crude Oil and Natural Gas Wells. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.average_depth_of_crude_oil_and_natural_gas_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_depth_of_developmental_wells_drilled", + "average_depth_of_exploratory_wells_drilled", + "average_depth_of_exploratory_and_developmental_wells_drilled" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_average_depth_of_crude_oil_developmental_wells_drilled", + "us_average_depth_of_crude_oil_exploratory_wells_drilled", + "us_average_depth_of_crude_oil_exploratory_and_developmental", + "us_average_depth_of_crude_oil_natural_gas_and_dry_developmental_wells_drilled_feet_per_well", + "us_average_depth_of_crude_oil_natural_gas_and_dry_exploratory_wells_drilled_feet_per_well", + "us_average_depth_of_crude_oil_natural_gas_and_dry_exploratory_and_developmental_wells_drilled_feet_per_well", + "us_average_depth_of_dry_exploratory_and_developmental_wells", + "us_average_depth_of_dry_holes_developmental_wells_drilled", + "us_average_depth_of_dry_holes_exploratory_wells_drilled", + "us_average_depth_of_natural_gas_developmental_wells_drilled", + "us_average_depth_of_natural_gas_exploratory_wells_drilled", + "us_average_depth_of_natural_gas_exploratory_and" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasAverageDepthOfCrudeOilAndNaturalGasWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasAverageDepthOfCrudeOilAndNaturalGasWells", + "openapi_extra": { + "widget_config": { + "name": "Average Depth of Crude Oil and Natural Gas Wells", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasAverageDepthOfCrudeOilAndNaturalGasWells" + } + }, + "/eia/natural_gas/exploration_and_reserves/coalbed_methane": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Coalbed Methane. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.coalbed_methane(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "coalbed_methane_proved_reserves", + "coalbed_methane_reserves_acquisitions", + "coalbed_methane_reserves_adjustments", + "coalbed_methane_reserves_based_production", + "coalbed_methane_reserves_extensions", + "coalbed_methane_reserves_extensions_and_discoveries", + "coalbed_methane_reserves_new_field_discoveries", + "coalbed_methane_reserves_new_reservoir_discoveries_in_old", + "coalbed_methane_reserves_revision_decreases", + "coalbed_methane_reserves_revision_increases", + "coalbed_methane_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 560 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasCoalbedMethane", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasCoalbedMethane", + "openapi_extra": { + "widget_config": { + "name": "Coalbed Methane", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasCoalbedMethane" + } + }, + "/eia/natural_gas/exploration_and_reserves/costs_of_crude_oil_and_natural_gas_wells_drilled": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Costs of Crude Oil and Natural Gas Wells Drilled. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.costs_of_crude_oil_and_natural_gas_wells_drilled(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "nominal_cost_per_foot_of_dry_wells_drilled", + "nominal_cost_per_well_drilled", + "real_cost", + "real_cost_per_foot" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_nominal_cost_per_crude_oil_well_drilled", + "us_nominal_cost_per_crude_oil_natural_gas_and_dry_well", + "us_nominal_cost_per_dry_well_drilled", + "us_nominal_cost_per_foot_of_crude_oil_wells_drilled", + "us_nominal_cost_per_foot_of_crude_oil_natural_gas_and_dry", + "us_nominal_cost_per_foot_of_dry_wells_drilled", + "us_nominal_cost_per_foot_of_natural_gas_wells_drilled", + "us_nominal_cost_per_natural_gas_well_drilled", + "us_real_cost_per_crude_oil_natural_gas_and_dry_well_drilled", + "us_real_cost_per_foot_of_crude_oil_natural_gas_and_dry" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasCostsOfCrudeOilAndNaturalGasWellsDrilled", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasCostsOfCrudeOilAndNaturalGasWellsDrilled", + "openapi_extra": { + "widget_config": { + "name": "Costs of Crude Oil and Natural Gas Wells Drilled", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasCostsOfCrudeOilAndNaturalGasWellsDrilled" + } + }, + "/eia/natural_gas/exploration_and_reserves/crude_oil_and_natural_gas_drilling_activity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil and Natural Gas Drilling Activity. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.crude_oil_and_natural_gas_drilling_activity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "active_well_service_rigs_in_operation", + "rotary_rigs_in_operation" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil_and_natural_gas", + "rotary_rigs_in_operation", + "rotary_rigs_in_operation_gas", + "rotary_rigs_in_operation_oil" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_crude_oil_rotary_rigs_in_operation", + "us_crude_oil_and_natural_gas_active_well_service_rigs_in", + "us_crude_oil_and_natural_gas_rotary_rigs_in_operation", + "us_natural_gas_rotary_rigs_in_operation", + "us_offshore_crude_oil_and_natural_gas_rotary_rigs_in", + "us_onshore_crude_oil_and_natural_gas_rotary_rigs_in" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasCrudeOilAndNaturalGasDrillingActivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasCrudeOilAndNaturalGasDrillingActivity", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil and Natural Gas Drilling Activity", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasCrudeOilAndNaturalGasDrillingActivity" + } + }, + "/eia/natural_gas/exploration_and_reserves/crude_oil_and_natural_gas_exploratory_and_development_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil and Natural Gas Exploratory and Development Wells. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.crude_oil_and_natural_gas_exploratory_and_development_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "developmental_wells_drilled", + "exploratory_wells_drilled", + "exploratory_and_developmental_wells_drilled", + "footage_drilled_for_exploratory_and_developmental_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_crude_oil_developmental_wells_drilled", + "us_crude_oil_exploratory_wells_drilled", + "us_crude_oil_exploratory_and_developmental_wells_drilled", + "us_crude_oil_natural_gas_and_dry_developmental_wells_drilled", + "us_crude_oil_natural_gas_and_dry_exploratory_wells_drilled", + "us_crude_oil_natural_gas_and_dry_exploratory_and", + "us_dry_developmental_wells_drilled", + "us_dry_exploratory_wells_drilled", + "us_dry_exploratory_and_developmental_wells_drilled", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry", + "us_natural_gas_developmental_wells_drilled", + "us_natural_gas_exploratory_wells_drilled", + "us_natural_gas_exploratory_and_developmental_wells_drilled" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasCrudeOilAndNaturalGasExploratoryAndDevelopmentWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasCrudeOilAndNaturalGasExploratoryAndDevelopmentWells", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil and Natural Gas Exploratory and Development Wells", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasCrudeOilAndNaturalGasExploratoryAndDevelopmentWells" + } + }, + "/eia/natural_gas/exploration_and_reserves/crude_oil_plus_lease_condensate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Crude Oil plus Lease Condensate. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.crude_oil_plus_lease_condensate(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "production_from_reserves", + "proved_reserves", + "reserves_acquisitions", + "reserves_adjustments", + "reserves_extensions", + "reserves_extensions_and_discoveries", + "reserves_new_field_discoveries", + "reserves_new_reservoir_discoveries_in_old_fields", + "reserves_revision_decreases", + "reserves_revision_increases", + "reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 572 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasCrudeOilPlusLeaseCondensate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasCrudeOilPlusLeaseCondensate", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil plus Lease Condensate", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasCrudeOilPlusLeaseCondensate" + } + }, + "/eia/natural_gas/exploration_and_reserves/dry_natural_gas_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Dry Natural Gas Proved Reserves. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.dry_natural_gas_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "dry_expected_future_production", + "dry_production_from_reserves", + "dry_reserves_acquisitions", + "dry_reserves_adjustments", + "dry_reserves_extensions", + "dry_reserves_extensions_and_discoveries", + "dry_reserves_new_field_discoveries", + "dry_reserves_new_reservoir_discoveries_in_old_fields", + "dry_reserves_revision_decreases", + "dry_reserves_revision_increases", + "dry_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 561 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasDryNaturalGasProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasDryNaturalGasProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Dry Natural Gas Proved Reserves", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasDryNaturalGasProvedReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/federal_offshore_gulf_of_america_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Federal Offshore Gulf of America Proved Reserves. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.federal_offshore_gulf_of_america_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "dry_expected_future_production", + "dry_reserves_deepwater_percentage", + "dry_reserves_from_greater_than_200_meters", + "dry_reserves_from_less_than_200_meters", + "lease_condensate_proved_reserves", + "lease_condensate_reserves_deepwater_percentage", + "lease_condensate_reserves_from_greater_than_200_meters", + "lease_condensate_reserves_from_less_than_200_meters", + "proved_reserves", + "reserves_deepwater_percentage", + "reserves_greater_than_200_meters", + "reserves_less_than_200_meters", + "wet_after_lease_separation_proved_reserves", + "wet_after_lease_separation_reserves_deepwater_percentage", + "wet_after_lease_separation_reserves_from_greater_than_200", + "wet_after_lease_separation_reserves_from_less_than_200" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil", + "natural_gas", + "natural_gas_liquids_and_liquid_refinery_gases" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "gulf_of_america_federal_offshore_crude_oil_proved_reserves_million_barrels", + "gulf_of_america_federal_offshore_crude_oil_proved_reserves_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_crude_oil_proved_reserves_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_dry_natural_gas_expected", + "gulf_of_america_federal_offshore_dry_natural_gas_proved_reserves_from_greater_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_dry_natural_gas_proved_reserves_from_less_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_proved_reserves_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_proved_reserves_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_proved_reserves_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_proved_reserves_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_proved_reserves_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_proved_reserves_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_proved_reserves_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_proved_reserves_from_greater_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_proved_reserves_from_less_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_percentage_of_crude_oil", + "gulf_of_america_federal_offshore_percentage_of_dry_natural", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_liquids_lease_condensate_proved_reserves_from_greater_than_200_meters_deep", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_liquids_proved_reserves_from_greater_than_200_meters_deep", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_wet_after_lease_separation_proved_reserves_from_greater_than_200_meters_deep" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasFederalOffshoreGulfOfAmericaProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasFederalOffshoreGulfOfAmericaProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Federal Offshore Gulf of America Proved Reserves", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasFederalOffshoreGulfOfAmericaProvedReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/footage_drilled_for_crude_oil_and_natural_gas_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Footage Drilled for Crude Oil and Natural Gas Wells. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.footage_drilled_for_crude_oil_and_natural_gas_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "footage_drilled_for_developmental_wells", + "footage_drilled_for_exploratory_wells", + "footage_drilled_for_exploratory_and_developmental_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wells_dry", + "wells_gas", + "wells_oil", + "wells_total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_footage_drilled_for_crude_oil_developmental_wells", + "us_footage_drilled_for_crude_oil_exploratory_wells", + "us_footage_drilled_for_crude_oil_exploratory_and", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry_developmental_wells_thousand_feet", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry_exploratory_wells_thousand_feet", + "us_footage_drilled_for_crude_oil_natural_gas_and_dry_exploratory_and_developmental_wells_thousand_feet", + "us_footage_drilled_for_dry_developmental_wells", + "us_footage_drilled_for_dry_exploratory_wells", + "us_footage_drilled_for_dry_exploratory_and_developmental", + "us_footage_drilled_for_natural_gas_developmental_wells", + "us_footage_drilled_for_natural_gas_exploratory_wells", + "us_footage_drilled_for_natural_gas_exploratory_and" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasFootageDrilledForCrudeOilAndNaturalGasWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasFootageDrilledForCrudeOilAndNaturalGasWells", + "openapi_extra": { + "widget_config": { + "name": "Footage Drilled for Crude Oil and Natural Gas Wells", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasFootageDrilledForCrudeOilAndNaturalGasWells" + } + }, + "/eia/natural_gas/exploration_and_reserves/lease_condensate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Lease Condensate. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.lease_condensate(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "lease_condensate_proved_reserves", + "lease_condensate_reserves_acquisitions", + "lease_condensate_reserves_adjustments", + "lease_condensate_reserves_based_production", + "lease_condensate_reserves_extensions", + "lease_condensate_reserves_extensions_and_discoveries", + "lease_condensate_reserves_new_field_discoveries", + "lease_condensate_reserves_new_reservoir_discoveries_in_old", + "lease_condensate_reserves_revision_decreases", + "lease_condensate_reserves_revision_increases", + "lease_condensate_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 552 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasLeaseCondensate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasLeaseCondensate", + "openapi_extra": { + "widget_config": { + "name": "Lease Condensate", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasLeaseCondensate" + } + }, + "/eia/natural_gas/exploration_and_reserves/maximum_us_active_seismic_crew_counts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Maximum US Active Seismic Crew Counts. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.maximum_us_active_seismic_crew_counts(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "maximum_number_of_active_crews_engaged_in_four_dimensional", + "maximum_number_of_active_crews_engaged_in_sismic_surveying", + "maximum_number_of_active_crews_engaged_in_three_dimensional", + "maximum_number_of_active_crews_engaged_in_two_dimensional" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "us", + "usa_ak" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alaska_maximum_number_of_active_crews_engaged_in_four", + "alaska_maximum_number_of_active_crews_engaged_in_seismic", + "alaska_maximum_number_of_active_crews_engaged_in_three", + "alaska_maximum_number_of_active_crews_engaged_in_two", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_seismic_surveying_count", + "us_maximum_number_of_active_crews_engaged_in_seismic", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_four_dimensional_seismic_surveying_count", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_three_dimensional_seismic_surveying_count", + "us_lower_48_states_offshore_maximum_number_of_active_crews_engaged_in_two_dimensional_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_four_dimensional_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_three_dimensional_seismic_surveying_count", + "us_lower_48_states_onshore_maximum_number_of_active_crews_engaged_in_two_dimensional_seismic_surveying_count" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasMaximumUsActiveSeismicCrewCounts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasMaximumUsActiveSeismicCrewCounts", + "openapi_extra": { + "widget_config": { + "name": "Maximum U.S. Active Seismic Crew Counts", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasMaximumUsActiveSeismicCrewCounts" + } + }, + "/eia/natural_gas/exploration_and_reserves/natural_gas_liquids_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Liquids Proved Reserves. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.natural_gas_liquids_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "production_from_reserves", + "proved_reserves", + "reserves_acquisitions", + "reserves_adjustments", + "reserves_extensions", + "reserves_new_field_discoveries", + "reserves_new_reservoir_discoveries_in_old_fields", + "reserves_revision_decreases", + "reserves_revision_increases", + "reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 494 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasLiquidsProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasLiquidsProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Liquids Proved Reserves", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasLiquidsProvedReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/natural_gas_proved_reserves_wet_after_lease_separation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Proved Reserves, Wet After Lease Separation. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.natural_gas_proved_reserves_wet_after_lease_separation(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "wet_after_lease_separation_proved_reserves", + "wet_after_lease_separation_reserves_acquisitions", + "wet_after_lease_separation_reserves_adjustments", + "wet_after_lease_separation_reserves_based_production_from", + "wet_after_lease_separation_reserves_extensions", + "wet_after_lease_separation_reserves_extensions_and", + "wet_after_lease_separation_reserves_new_field_discoveries", + "wet_after_lease_separation_reserves_new_reservoir", + "wet_after_lease_separation_reserves_revision_decreases", + "wet_after_lease_separation_reserves_revision_increases", + "wet_after_lease_separation_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 561 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasProvedReservesWetAfterLeaseSeparation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasProvedReservesWetAfterLeaseSeparation", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Proved Reserves, Wet After Lease Separation", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasProvedReservesWetAfterLeaseSeparation" + } + }, + "/eia/natural_gas/exploration_and_reserves/natural_gas_reserves_summary_as_of_dec_31": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Reserves Summary as of Dec. 31. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.natural_gas_reserves_summary_as_of_dec_31(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "associated_dissolved_proved_reserves", + "dry_expected_future_production", + "nonassociated_proved_reserves", + "proved_reserves", + "wet_after_lease_separation_proved_reserves" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "natural_gas", + "natural_gas_liquids_and_liquid_refinery_gases" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 256 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasReservesSummaryAsOfDec31", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasReservesSummaryAsOfDec31", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Reserves Summary as of Dec. 31", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasReservesSummaryAsOfDec31" + } + }, + "/eia/natural_gas/exploration_and_reserves/nonassociated_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Nonassociated Natural Gas Proved Reserves, Wet After Lease Separation. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.nonassociated_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "nonassociated_production_from_reserves", + "nonassociated_proved_reserves", + "nonassociated_reserves_acquisitions", + "nonassociated_reserves_adjustments", + "nonassociated_reserves_extensions", + "nonassociated_reserves_extensions_and_discoveries", + "nonassociated_reserves_new_field_discoveries", + "nonassociated_reserves_new_reservoir_discoveries_in_old", + "nonassociated_reserves_revision_decreases", + "nonassociated_reserves_revision_increases", + "nonassociated_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 572 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNonassociatedProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNonassociatedProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Nonassociated Natural Gas Proved Reserves, Wet After Lease Separation", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNonassociatedProvedReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/plant_liquids_in_proved_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimated Natural Gas Plant Liquids contained in Total Natural Gas Proved Reserves. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.plant_liquids_in_proved_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_plant_liquids_expected_future_production", + "alaska_natural_gas_plant_liquids_expected_future_production", + "arkansas_natural_gas_plant_liquids_expected_future", + "california_natural_gas_plant_liquids_expected_future", + "california_coastal_region_onshore_natural_gas_plant_liquids", + "california_los_angeles_basin_onshore_natural_gas_plant", + "california_san_joaquin_basin_onshore_natural_gas_plant", + "california_state_offshore_natural_gas_plant_liquids", + "colorado_natural_gas_plant_liquids_expected_future", + "federal_offshore_california_natural_gas_plant_liquids", + "florida_natural_gas_plant_liquids_expected_future_production", + "gulf_of_america_federal_offshore_central_and_eastern_natural_gas_plant_liquids_expected_future_production_million_barrels", + "gulf_of_america_federal_offshore_western_natural_gas_plant_liquids_expected_future_production_million_barrels", + "kansas_natural_gas_plant_liquids_expected_future_production", + "kentucky_natural_gas_plant_liquids_expected_future", + "louisiana_natural_gas_plant_liquids_expected_future", + "louisiana_north_natural_gas_plant_liquids_expected_future", + "louisiana_south_onshore_natural_gas_plant_liquids_expected", + "louisiana_state_offshore_natural_gas_plant_liquids_expected", + "lower_48_federal_offshore_natural_gas_plant_liquids", + "lower_48_states_natural_gas_plant_liquids_expected_future", + "michigan_natural_gas_plant_liquids_expected_future", + "mississippi_natural_gas_plant_liquids_expected_future", + "montana_natural_gas_plant_liquids_expected_future_production", + "new_mexico_natural_gas_plant_liquids_expected_future", + "new_mexico_east_natural_gas_plant_liquids_expected_future", + "new_mexico_west_natural_gas_plant_liquids_expected_future", + "north_dakota_natural_gas_plant_liquids_expected_future", + "ohio_natural_gas_plant_liquids_expected_future_production", + "oklahoma_natural_gas_plant_liquids_expected_future", + "pennsylvania_natural_gas_plant_liquids_expected_future", + "texas_natural_gas_plant_liquids_expected_future_production", + "texas_rrc_district_1_natural_gas_plant_liquids_expected", + "texas_rrc_district_10_natural_gas_plant_liquids_expected", + "texas_rrc_district_2_onshore_natural_gas_plant_liquids", + "texas_rrc_district_3_onshore_natural_gas_plant_liquids", + "texas_rrc_district_4_onshore_natural_gas_plant_liquids", + "texas_rrc_district_5_natural_gas_plant_liquids_expected", + "texas_rrc_district_6_natural_gas_plant_liquids_expected", + "texas_rrc_district_7b_natural_gas_plant_liquids_expected", + "texas_rrc_district_7c_natural_gas_plant_liquids_expected", + "texas_rrc_district_8_natural_gas_plant_liquids_expected", + "texas_rrc_district_8a_natural_gas_plant_liquids_expected", + "texas_rrc_district_9_natural_gas_plant_liquids_expected", + "texas_state_offshore_natural_gas_plant_liquids_expected", + "us_natural_gas_plant_liquids_expected_future_production", + "utah_natural_gas_plant_liquids_expected_future_production", + "utah_and_wyoming_natural_gas_plant_liquids_expected_future", + "west_virginia_natural_gas_plant_liquids_expected_future", + "wyoming_natural_gas_plant_liquids_expected_future_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasPlantLiquidsInProvedReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasPlantLiquidsInProvedReserves", + "openapi_extra": { + "widget_config": { + "name": "Estimated Natural Gas Plant Liquids contained in Total Natural Gas Proved Reserves", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasPlantLiquidsInProvedReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/proved_nonproducing_reserves": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Proved Nonproducing Reserves. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.proved_nonproducing_reserves(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "associated_dissolved_reserves_in_nonproducing_reservoirs", + "lease_condensate_reserves_in_nonproducing_reservoirs", + "nonassociated_reserves_in_nonproducing_reservoirs", + "reserves_in_nonproducing_reservoirs", + "wet_after_lease_separation_reserves_in_nonproducing" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil", + "natural_gas", + "natural_gas_liquids_and_liquid_refinery_gases" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 270 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasProvedNonproducingReserves", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasProvedNonproducingReserves", + "openapi_extra": { + "widget_config": { + "name": "Proved Nonproducing Reserves", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasProvedNonproducingReserves" + } + }, + "/eia/natural_gas/exploration_and_reserves/shale_gas": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Shale Gas. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.exploration_and_reserves.shale_gas(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "shale_proved_reserves", + "shale_reserves_acquisitions", + "shale_reserves_adjustments", + "shale_reserves_based_production", + "shale_reserves_extensions", + "shale_reserves_extensions_and_discoveries", + "shale_reserves_new_field_discoveries", + "shale_reserves_new_reservoir_discoveries_in_old_fields", + "shale_reserves_revision_decreases", + "shale_reserves_revision_increases", + "shale_reserves_sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 485 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasShaleGas", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasShaleGas", + "openapi_extra": { + "widget_config": { + "name": "Shale Gas", + "category": "EIA", + "subCategory": "Exploration and Reserves", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasShaleGas" + } + }, + "/eia/natural_gas/imports_and_exports_pipelines/international_interstate_movements_of_natural_gas_by_state": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "International & Interstate Movements of Natural Gas by State. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.imports_and_exports_pipelines.international_interstate_movements_of_natural_gas_by_state(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "exports_intransit", + "imports_intransit", + "interstate_and_across_us_borders_delivered_exports_to", + "interstate_and_across_us_borders_net_interstate_receipts", + "interstate_and_across_us_borders_receipts_imports", + "interstate_movements_deliveries", + "interstate_movements_net_receipts", + "interstate_movements_receipts", + "net_movements_across_us_borders" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 738 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasInternationalInterstateMovementsOfNaturalGasByState", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasInternationalInterstateMovementsOfNaturalGasByState", + "openapi_extra": { + "widget_config": { + "name": "International & Interstate Movements of Natural Gas by State", + "category": "EIA", + "subCategory": "Imports and Exports/Pipelines", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasInternationalInterstateMovementsOfNaturalGasByState" + } + }, + "/eia/natural_gas/imports_and_exports_pipelines/us_natural_gas_exports_and_re_exports_by_country": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Natural Gas Exports and Re-Exports by Country. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_exports_and_re_exports_by_country(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_natural_gas_exports", + "compressed_natural_gas_exports_for_price", + "exports", + "exports_price", + "exports_by_truck", + "exports_by_vessel", + "exports_by_vessel_and_truck", + "liquefied_natural_gas_exports", + "liquefied_natural_gas_exports_price", + "pipeline_exports", + "pipeline_exports_price", + "re_exports" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "are", + "arg", + "atg", + "bel", + "bgd", + "bhr", + "bhs", + "bra", + "brb", + "can", + "chl", + "chn", + "col", + "deu", + "dom", + "egy", + "esp", + "fra", + "gbr", + "grc", + "hrv", + "hti", + "idn", + "ind", + "isr", + "ita", + "jam", + "jor", + "jpn", + "kor", + "kwt", + "ltu", + "mex", + "mrt", + "mys", + "na", + "nic", + "nld", + "pak", + "pan", + "phl", + "pol", + "prt", + "rus", + "sen", + "sgp", + "slv", + "tha", + "tur", + "twn", + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 154 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsNaturalGasExportsAndReExportsByCountry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsNaturalGasExportsAndReExportsByCountry", + "openapi_extra": { + "widget_config": { + "name": "U.S. Natural Gas Exports and Re-Exports by Country", + "category": "EIA", + "subCategory": "Imports and Exports/Pipelines", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsNaturalGasExportsAndReExportsByCountry" + } + }, + "/eia/natural_gas/imports_and_exports_pipelines/us_natural_gas_exports_and_re_exports_by_point_of_exit": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Natural Gas Exports and Re-Exports by Point of Exit. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_exports_and_re_exports_by_point_of_exit(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_natural_gas_exports", + "compressed_natural_gas_exports_for_price", + "liquefied_natural_gas_exports", + "liquefied_natural_gas_exports_price", + "pipeline_exports", + "pipeline_exports_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 446 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 934 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsNaturalGasExportsAndReExportsByPointOfExit", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsNaturalGasExportsAndReExportsByPointOfExit", + "openapi_extra": { + "widget_config": { + "name": "U.S. Natural Gas Exports and Re-Exports by Point of Exit", + "category": "EIA", + "subCategory": "Imports and Exports/Pipelines", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsNaturalGasExportsAndReExportsByPointOfExit" + } + }, + "/eia/natural_gas/imports_and_exports_pipelines/us_natural_gas_imports_by_country": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Natural Gas Imports by Country. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_imports_by_country(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_natural_gas_imports", + "compressed_natural_gas_imports_for_price", + "imports", + "imports_price", + "lng_imports", + "liquefied_natural_gas_imports", + "pipeline_imports", + "pipeline_imports_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "are", + "aus", + "brn", + "can", + "dza", + "egy", + "fra", + "gbr", + "gnq", + "idn", + "jam", + "mex", + "mys", + "na", + "nga", + "nor", + "omn", + "per", + "qat", + "tto", + "us", + "yem" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_us_natural_gas_imports", + "compressed_us_natural_gas_imports_from_canada", + "price_of_compressed_us_natural_gas_imports", + "price_of_compressed_us_natural_gas_imports_from_canada", + "price_of_us_liquefied_natural_gas_imports_from_algeria", + "price_of_us_liquefied_natural_gas_imports_from_australia", + "price_of_us_liquefied_natural_gas_imports_from_brunei", + "price_of_us_liquefied_natural_gas_imports_from_canada", + "price_of_us_liquefied_natural_gas_imports_from_egypt", + "price_of_us_liquefied_natural_gas_imports_from_equatorial", + "price_of_us_liquefied_natural_gas_imports_from_france", + "price_of_us_liquefied_natural_gas_imports_from_indonesia", + "price_of_us_liquefied_natural_gas_imports_from_malaysia", + "price_of_us_liquefied_natural_gas_imports_from_nigeria", + "price_of_us_liquefied_natural_gas_imports_from_norway", + "price_of_us_liquefied_natural_gas_imports_from_oman", + "price_of_us_liquefied_natural_gas_imports_from_other", + "price_of_us_liquefied_natural_gas_imports_from_peru", + "price_of_us_liquefied_natural_gas_imports_from_qatar", + "price_of_us_liquefied_natural_gas_imports_from_the_united", + "price_of_us_liquefied_natural_gas_imports_from_trinidad_and", + "price_of_us_liquefied_natural_gas_imports_from_united", + "price_of_us_liquefied_natural_gas_imports_from_yemen", + "price_of_us_liquefied_natural_gas_imports_from_jamaica", + "price_of_us_natural_gas_imports", + "price_of_us_natural_gas_lng_imports", + "price_of_us_natural_gas_pipeline_imports_from_canada", + "price_of_us_natural_gas_pipeline_imports_from_mexico", + "us_liquefied_natural_gas_imports", + "us_liquefied_natural_gas_imports_from_algeria", + "us_liquefied_natural_gas_imports_from_australia", + "us_liquefied_natural_gas_imports_from_brunei", + "us_liquefied_natural_gas_imports_from_canada", + "us_liquefied_natural_gas_imports_from_egypt", + "us_liquefied_natural_gas_imports_from_equatorial_guinea", + "us_liquefied_natural_gas_imports_from_france", + "us_liquefied_natural_gas_imports_from_indonesia", + "us_liquefied_natural_gas_imports_from_malaysia", + "us_liquefied_natural_gas_imports_from_nigeria", + "us_liquefied_natural_gas_imports_from_norway", + "us_liquefied_natural_gas_imports_from_oman", + "us_liquefied_natural_gas_imports_from_other_countries", + "us_liquefied_natural_gas_imports_from_peru", + "us_liquefied_natural_gas_imports_from_qatar", + "us_liquefied_natural_gas_imports_from_the_united_arab", + "us_liquefied_natural_gas_imports_from_trinidad_and_tobago", + "us_liquefied_natural_gas_imports_from_united_kingdom", + "us_liquefied_natural_gas_imports_from_yemen", + "us_liquefied_natural_gas_imports_from_jamaica", + "us_natural_gas_imports", + "us_natural_gas_pipeline_imports", + "us_natural_gas_pipeline_imports_from_canada", + "us_natural_gas_pipeline_imports_from_mexico", + "us_natural_gas_pipeline_imports_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsNaturalGasImportsByCountry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsNaturalGasImportsByCountry", + "openapi_extra": { + "widget_config": { + "name": "U.S. Natural Gas Imports by Country", + "category": "EIA", + "subCategory": "Imports and Exports/Pipelines", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsNaturalGasImportsByCountry" + } + }, + "/eia/natural_gas/imports_and_exports_pipelines/us_natural_gas_imports_by_point_of_entry": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Natural Gas Imports by Point of Entry. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_imports_by_point_of_entry(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_natural_gas_imports", + "compressed_natural_gas_imports_for_price", + "lng_imports", + "liquefied_natural_gas_imports", + "pipeline_imports", + "pipeline_imports_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. There are 110 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 252 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsNaturalGasImportsByPointOfEntry", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsNaturalGasImportsByPointOfEntry", + "openapi_extra": { + "widget_config": { + "name": "U.S. Natural Gas Imports by Point of Entry", + "category": "EIA", + "subCategory": "Imports and Exports/Pipelines", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsNaturalGasImportsByPointOfEntry" + } + }, + "/eia/natural_gas/imports_and_exports_pipelines/us_natural_gas_imports_exports_by_state": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Natural Gas Imports & Exports by State. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.imports_and_exports_pipelines.us_natural_gas_imports_exports_by_state(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "exports", + "exports_price", + "imports", + "imports_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "price_of_us_natural_gas_exports", + "price_of_us_natural_gas_imports", + "us_natural_gas_exports", + "us_natural_gas_imports" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsNaturalGasImportsExportsByState", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsNaturalGasImportsExportsByState", + "openapi_extra": { + "widget_config": { + "name": "U.S. Natural Gas Imports & Exports by State", + "category": "EIA", + "subCategory": "Imports and Exports/Pipelines", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsNaturalGasImportsExportsByState" + } + }, + "/eia/natural_gas/prices/natural_gas_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Prices. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.prices.natural_gas_prices(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "of_industrial_consumers_sales", + "city_gate_price", + "electric_power_price", + "exports", + "imports_price", + "industrial_price", + "lng_imports", + "liquefied_natural_gas_exports_price", + "percent_sold_to_the_commercial_sector", + "percent_sold_to_the_residential_consumers", + "pipeline_exports", + "pipeline_imports_price", + "price_delivered_to_commercial_sectors", + "price_delivered_to_residential_consumers", + "wellhead_acquisition_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 423 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasPrices", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Prices", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasPrices" + } + }, + "/eia/natural_gas/prices/natural_gas_spot_and_futures_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Spot and Futures Prices (NYMEX) (Futures prices after April 5, 2024, are not available). EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.prices.natural_gas_spot_and_futures_prices(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'weekly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "future_contract_1", + "future_contract_2", + "future_contract_3", + "future_contract_4", + "spot_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na", + "new_york_city" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "henry_hub_natural_gas_spot_price", + "natural_gas_futures_contract_1", + "natural_gas_futures_contract_2", + "natural_gas_futures_contract_3", + "natural_gas_futures_contract_4" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasSpotAndFuturesPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasSpotAndFuturesPrices", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Spot and Futures Prices (NYMEX) (Futures prices after April 5, 2024, are not available)", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasSpotAndFuturesPrices" + } + }, + "/eia/natural_gas/prices/residential_and_commercial_prices_selected_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Average Price of Natural Gas Delivered to Residential and Commercial Consumers by Local Distribution and Marketers in Selected States. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.prices.residential_and_commercial_prices_selected_states(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "price_delivered_to_commercial_sectors", + "price_delivered_to_residential_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "florida", + "new_york", + "ohio", + "usa_dc", + "usa_ga", + "usa_md", + "usa_mi", + "usa_nj", + "usa_pa", + "usa_va" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "district_of_columbia_price_of_natural_gas_delivered_to", + "district_of_columbia_price_of_natural_gas_sold_to", + "florida_price_of_natural_gas_delivered_to_residential", + "florida_price_of_natural_gas_sold_to_commercial_consumers", + "georgia_price_of_natural_gas_delivered_to_residential", + "georgia_price_of_natural_gas_sold_to_commercial_consumers", + "maryland_price_of_natural_gas_delivered_to_residential", + "maryland_price_of_natural_gas_sold_to_commercial_consumers", + "michigan_price_of_natural_gas_delivered_to_residential", + "michigan_price_of_natural_gas_sold_to_commercial_consumers", + "new_jersey_price_of_natural_gas_delivered_to_residential", + "new_jersey_price_of_natural_gas_sold_to_commercial_consumers", + "new_york_price_of_natural_gas_delivered_to_residential", + "new_york_price_of_natural_gas_sold_to_commercial_consumers", + "ohio_price_of_natural_gas_delivered_to_residential_consumers", + "ohio_price_of_natural_gas_sold_to_commercial_consumers", + "pennsylvania_price_of_natural_gas_delivered_to_residential", + "pennsylvania_price_of_natural_gas_sold_to_commercial", + "virginia_price_of_natural_gas_delivered_to_residential", + "virginia_price_of_natural_gas_sold_to_commercial_consumers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasResidentialAndCommercialPricesSelectedStates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasResidentialAndCommercialPricesSelectedStates", + "openapi_extra": { + "widget_config": { + "name": "Average Price of Natural Gas Delivered to Residential and Commercial Consumers by Local Distribution and Marketers in Selected States", + "category": "EIA", + "subCategory": "Prices", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasResidentialAndCommercialPricesSelectedStates" + } + }, + "/eia/natural_gas/production/coalbed_methane_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Coalbed Methane Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.coalbed_methane_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_coalbed_methane_production", + "alaska_coalbed_methane_production", + "arkansas_coalbed_methane_production", + "california_coalbed_methane_production", + "colorado_coalbed_methane_production", + "eastern_states_coalbed_methane_production", + "florida_coalbed_methane_production", + "kansas_coalbed_methane_production", + "kentucky_coalbed_methane_production", + "louisiana_coalbed_methane_production", + "louisiana_north_coalbed_methane_production", + "louisiana_south_onshore_coalbed_methane_production", + "louisiana_state_offshore_coalbed_methane_production", + "lower_48_federal_offshore_coalbed_methane_production", + "lower_48_states_coalbed_methane_production", + "michigan_coalbed_methane_production", + "mississippi_coalbed_methane_production", + "montana_coalbed_methane_production", + "new_mexico_coalbed_methane_production", + "new_mexico_east_coalbed_methane_production", + "new_mexico_west_coalbed_methane_production", + "new_york_coalbed_methane_production", + "north_dakota_coalbed_methane_production", + "ohio_coalbed_methane_production", + "oklahoma_coalbed_methane_production", + "other_states_natural_gas_coalbed_methane_reserves_based", + "pennsylvania_coalbed_methane_production", + "texas_coalbed_methane_production", + "texas_rrc_district_1_coalbed_methane_production", + "texas_rrc_district_10_coalbed_methane_production", + "texas_rrc_district_2_onshore_coalbed_methane_production", + "texas_rrc_district_3_onshore_coalbed_methane_production", + "texas_rrc_district_4_onshore_coalbed_methane_production", + "texas_rrc_district_5_coalbed_methane_production", + "texas_rrc_district_6_coalbed_methane_production", + "texas_rrc_district_7b_coalbed_methane_production", + "texas_rrc_district_7c_coalbed_methane_production", + "texas_rrc_district_8_coalbed_methane_production", + "texas_rrc_district_8a_coalbed_methane_production", + "texas_rrc_district_9_coalbed_methane_production", + "texas_state_offshore_coalbed_methane_production", + "us_coalbed_methane_production", + "utah_coalbed_methane_production", + "virginia_coalbed_methane_production", + "west_virginia_coalbed_methane_production", + "western_states_coalbed_methane_production", + "wyoming_coalbed_methane_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasCoalbedMethaneProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasCoalbedMethaneProduction", + "openapi_extra": { + "widget_config": { + "name": "Coalbed Methane Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasCoalbedMethaneProduction" + } + }, + "/eia/natural_gas/production/gulf_of_america_federal_offshore_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Gulf of America Federal Offshore Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.gulf_of_america_federal_offshore_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "dry_production_from_reserves", + "dry_reserves_based_production_deepwater_percentage", + "dry_reserves_based_production_from_greater_than_200_meters", + "dry_reserves_based_production_from_less_than_200_meters", + "lease_condensate_reserves_based_production", + "lease_condensate_reserves_based_production_deepwater", + "lease_condensate_reserves_based_production_from_greater", + "lease_condensate_reserves_based_production_from_less_than", + "production_from_reserves", + "reserves_based_production_deepwater_percentage", + "reserves_based_production_from_greater_than_200_meters", + "reserves_based_production_from_less_than_200_meters", + "wet_after_lease_separation_reserves_based_production", + "wet_after_lease_separation_reserves_based_production_from_greater_than_200_meters", + "wet_after_lease_separation_reserves_based_production_from_less_than_200_meters", + "wet_after_lease_separation_reserves_based_production_from_reserves" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "crude_oil", + "natural_gas", + "natural_gas_liquids_and_liquid_refinery_gases" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "gulf_of_america_federal_offshore_crude_oil_production", + "gulf_of_america_federal_offshore_crude_oil_production_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_crude_oil_production_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_dry_natural_gas_production_billion_cubic_feet", + "gulf_of_america_federal_offshore_dry_natural_gas_production_from_greater_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_dry_natural_gas_production_from_less_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_production_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_production_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_lease_condensate_production_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_production_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_production_from_greater_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_liquids_production_from_less_than_200_meters_deep_million_barrels", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_production_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_production_from_greater_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_natural_gas_wet_after_lease_separation_production_from_less_than_200_meters_deep_billion_cubic_feet", + "gulf_of_america_federal_offshore_percentage_of_crude_oil", + "gulf_of_america_federal_offshore_percentage_of_dry_natural", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_liquids_lease_condensate_production_from_greater_than_200_meters_deep", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_liquids_production_from_greater_than_200_meters_deep", + "gulf_of_america_federal_offshore_percentage_of_natural_gas_wet_after_lease_separation_production_from_greater_than_200_meters_deep" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasGulfOfAmericaFederalOffshoreProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasGulfOfAmericaFederalOffshoreProduction", + "openapi_extra": { + "widget_config": { + "name": "Gulf of America Federal Offshore Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasGulfOfAmericaFederalOffshoreProduction" + } + }, + "/eia/natural_gas/production/lease_condensate_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Lease Condensate Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.lease_condensate_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_liquids_lease_condensate_reserves_based", + "alaska_natural_gas_liquids_lease_condensate_reserves_based", + "arkansas_natural_gas_liquids_lease_condensate_reserves", + "calif_coastal_region_onshore_natural_gas_liquids_lease", + "calif_los_angeles_basin_onshore_natural_gas_liquids_lease", + "calif_san_joaquin_basin_onshore_natural_gas_liquids_lease", + "california_natural_gas_liquids_lease_condensate_reserves", + "california_state_offshore_natural_gas_liquids_lease", + "colorado_natural_gas_liquids_lease_condensate_reserves", + "federal_offshore_california_natural_gas_liquids_lease", + "florida_natural_gas_liquids_lease_condensate_reserves_based", + "gulf_of_america_federal_offshore_central_and_eastern_natural_gas_liquids_lease_condensate_reserves_based_production_million_barrels", + "gulf_of_america_federal_offshore_western_natural_gas_liquids_lease_condensate_reserves_based_production_million_barrels", + "kansas_natural_gas_liquids_lease_condensate_reserves_based", + "kentucky_natural_gas_liquids_lease_condensate_reserves", + "louisiana_natural_gas_liquids_lease_condensate_reserves", + "louisiana_north_natural_gas_liquids_lease_condensate", + "louisiana_south_onshore_natural_gas_liquids_lease", + "louisiana_state_offshore_natural_gas_liquids_lease", + "lower_48_federal_offshore_natural_gas_liquids_lease", + "lower_48_states_natural_gas_liquids_lease_condensate", + "michigan_natural_gas_liquids_lease_condensate_reserves", + "mississippi_natural_gas_liquids_lease_condensate_reserves", + "montana_natural_gas_liquids_lease_condensate_reserves_based", + "new_mexico_natural_gas_liquids_lease_condensate_reserves", + "new_mexico_east_natural_gas_liquids_lease_condensate", + "new_mexico_west_natural_gas_liquids_lease_condensate", + "north_dakota_natural_gas_liquids_lease_condensate_reserves", + "oklahoma_natural_gas_liquids_lease_condensate_reserves", + "texas_natural_gas_liquids_lease_condensate_reserves_based", + "texas_rrc_district_1_natural_gas_liquids_lease_condensate", + "texas_rrc_district_10_natural_gas_liquids_lease_condensate", + "texas_rrc_district_2_onshore_natural_gas_liquids_lease", + "texas_rrc_district_3_onshore_natural_gas_liquids_lease", + "texas_rrc_district_4_onshore_natural_gas_liquids_lease", + "texas_rrc_district_5_natural_gas_liquids_lease_condensate", + "texas_rrc_district_6_natural_gas_liquids_lease_condensate", + "texas_rrc_district_7b_natural_gas_liquids_lease_condensate", + "texas_rrc_district_7c_natural_gas_liquids_lease_condensate", + "texas_rrc_district_8_natural_gas_liquids_lease_condensate", + "texas_rrc_district_8a_natural_gas_liquids_lease_condensate", + "texas_rrc_district_9_natural_gas_liquids_lease_condensate", + "texas_state_offshore_natural_gas_liquids_lease_condensate", + "us_natural_gas_liquids_lease_condensate_reserves_based", + "utah_natural_gas_liquids_lease_condensate_reserves_based", + "utah_and_wyoming_natural_gas_liquids_lease_condensate", + "west_virginia_natural_gas_liquids_lease_condensate_reserves", + "wyoming_natural_gas_liquids_lease_condensate_reserves_based" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasLeaseCondensateProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasLeaseCondensateProduction", + "openapi_extra": { + "widget_config": { + "name": "Lease Condensate Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasLeaseCondensateProduction" + } + }, + "/eia/natural_gas/production/natural_gas_gross_withdrawals_and_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Gross Withdrawals and Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.natural_gas_gross_withdrawals_and_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "dry_production", + "extraction_loss", + "gross_withdrawals", + "marketed_production", + "removed_from_natural_gas", + "repressuring", + "vented_and_flared", + "withdrawals_from_coalbed_wells", + "withdrawals_from_gas_wells", + "withdrawals_from_oil_wells", + "withdrawals_from_shale_gas" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 434 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasGrossWithdrawalsAndProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasGrossWithdrawalsAndProduction", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Gross Withdrawals and Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasGrossWithdrawalsAndProduction" + } + }, + "/eia/natural_gas/production/natural_gas_plant_liquids_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Plant Liquids Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.natural_gas_plant_liquids_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_plant_liquids_reserves_based_production", + "alaska_natural_gas_plant_liquids_reserves_based_production", + "arkansas_natural_gas_plant_liquids_reserves_based_production", + "calif_coastal_region_onshore_natural_gas_plant_liquids", + "calif_los_angeles_basin_onshore_natural_gas_plant_liquids", + "calif_san_joaquin_basin_onshore_natural_gas_plant_liquids", + "california_natural_gas_plant_liquids_reserves_based", + "california_state_offshore_natural_gas_plant_liquids", + "colorado_natural_gas_plant_liquids_reserves_based_production", + "federal_offshore_california_natural_gas_plant_liquids", + "florida_natural_gas_plant_liquids_reserves_based_production", + "gulf_of_america_federal_offshore_central_and_eastern_natural_gas_plant_liquids_reserves_based_production_million_barrels", + "gulf_of_america_federal_offshore_western_natural_gas_plant_liquids_reserves_based_production_million_barrels", + "kansas_natural_gas_plant_liquids_reserves_based_production", + "kentucky_natural_gas_plant_liquids_reserves_based_production", + "louisiana_natural_gas_plant_liquids_reserves_based", + "louisiana_north_natural_gas_plant_liquids_reserves_based", + "louisiana_south_onshore_natural_gas_plant_liquids_reserves", + "louisiana_state_offshore_natural_gas_plant_liquids_reserves", + "lower_48_federal_offshore_natural_gas_plant_liquids", + "lower_48_states_natural_gas_plant_liquids_reserves_based", + "michigan_natural_gas_plant_liquids_reserves_based_production", + "mississippi_natural_gas_plant_liquids_reserves_based", + "montana_natural_gas_plant_liquids_reserves_based_production", + "new_mexico_natural_gas_plant_liquids_reserves_based", + "new_mexico_east_natural_gas_plant_liquids_reserves_based", + "new_mexico_west_natural_gas_plant_liquids_reserves_based", + "north_dakota_natural_gas_plant_liquids_reserves_based", + "ohio_natural_gas_plant_liquids_reserves_based_production", + "oklahoma_natural_gas_plant_liquids_reserves_based_production", + "texas_natural_gas_plant_liquids_reserves_based_production", + "texas_rrc_district_1_natural_gas_plant_liquids_reserves", + "texas_rrc_district_10_natural_gas_plant_liquids_reserves", + "texas_rrc_district_2_onshore_natural_gas_plant_liquids", + "texas_rrc_district_3_onshore_natural_gas_plant_liquids", + "texas_rrc_district_4_onshore_natural_gas_plant_liquids", + "texas_rrc_district_5_natural_gas_plant_liquids_reserves", + "texas_rrc_district_6_natural_gas_plant_liquids_reserves", + "texas_rrc_district_7b_natural_gas_plant_liquids_reserves", + "texas_rrc_district_7c_natural_gas_plant_liquids_reserves", + "texas_rrc_district_8_natural_gas_plant_liquids_reserves", + "texas_rrc_district_8a_natural_gas_plant_liquids_reserves", + "texas_rrc_district_9_natural_gas_plant_liquids_reserves", + "texas_state_offshore_natural_gas_plant_liquids_reserves", + "us_natural_gas_plant_liquids_reserves_based_production", + "utah_natural_gas_plant_liquids_reserves_based_production", + "utah_and_wyoming_natural_gas_plant_liquids_reserves_based", + "west_virginia_natural_gas_plant_liquids_reserves_based", + "wyoming_natural_gas_plant_liquids_reserves_based_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasPlantLiquidsProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasPlantLiquidsProduction", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Plant Liquids Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasPlantLiquidsProduction" + } + }, + "/eia/natural_gas/production/natural_gas_plant_processing": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Plant Processing. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.natural_gas_plant_processing(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_id", + "usa_il", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_plant_liquids_production", + "alaska_natural_gas_plant_liquids_production", + "arkansas_natural_gas_plant_liquids_production", + "california_natural_gas_plant_liquids_production", + "colorado_natural_gas_plant_liquids_production", + "florida_natural_gas_plant_liquids_production", + "gulf_of_america_natural_gas_plant_liquids_production", + "idaho_natural_gas_plant_liquids_production", + "illinois_natural_gas_plant_liquids_production", + "kansas_natural_gas_plant_liquids_production", + "kentucky_natural_gas_plant_liquids_production", + "louisiana_natural_gas_plant_liquids_production", + "michigan_natural_gas_plant_liquids_production", + "mississippi_natural_gas_plant_liquids_production", + "montana_natural_gas_plant_liquids_production", + "new_mexico_natural_gas_plant_liquids_production", + "north_dakota_natural_gas_plant_liquids_production", + "ohio_natural_gas_plant_liquids_production", + "oklahoma_natural_gas_plant_liquids_production", + "pennsylvania_natural_gas_plant_liquids_production", + "south_dakota_natural_gas_plant_liquids_production", + "tennessee_natural_gas_plant_liquids_production", + "texas_natural_gas_plant_liquids_production", + "us_natural_gas_plant_liquids_production", + "utah_natural_gas_plant_liquids_production", + "west_virginia_natural_gas_plant_liquids_production", + "wyoming_natural_gas_plant_liquids_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasPlantProcessing", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasPlantProcessing", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Plant Processing", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasPlantProcessing" + } + }, + "/eia/natural_gas/production/natural_gas_wellhead_value_and_marketed_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Wellhead Value and Marketed Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.natural_gas_wellhead_value_and_marketed_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "marketed_production", + "wellhead_acquisition_price" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_marketed_production", + "alaska_natural_gas_marketed_production", + "arizona_natural_gas_marketed_production", + "arkansas_natural_gas_marketed_production", + "california_natural_gas_marketed_production", + "colorado_natural_gas_marketed_production", + "federal_offshore_gulf_of_america_natural_gas_marketed", + "florida_natural_gas_marketed_production", + "idaho_marketed_production_of_natural_gas", + "illinois_natural_gas_marketed_production", + "indiana_natural_gas_marketed_production", + "kansas_natural_gas_marketed_production", + "kentucky_natural_gas_marketed_production", + "louisiana_natural_gas_marketed_production", + "maryland_natural_gas_marketed_production", + "michigan_natural_gas_marketed_production", + "mississippi_natural_gas_marketed_production", + "missouri_natural_gas_marketed_production", + "montana_natural_gas_marketed_production", + "nebraska_natural_gas_marketed_production", + "nevada_natural_gas_marketed_production", + "new_mexico_natural_gas_marketed_production", + "new_york_natural_gas_marketed_production", + "north_dakota_natural_gas_marketed_production", + "ohio_natural_gas_marketed_production", + "oklahoma_natural_gas_marketed_production", + "oregon_natural_gas_marketed_production", + "pennsylvania_natural_gas_marketed_production", + "south_dakota_natural_gas_marketed_production", + "tennessee_natural_gas_marketed_production", + "texas_natural_gas_marketed_production", + "us_natural_gas_marketed_production", + "us_natural_gas_wellhead_price", + "utah_natural_gas_marketed_production", + "virginia_natural_gas_marketed_production", + "west_virginia_natural_gas_marketed_production", + "wyoming_natural_gas_marketed_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasWellheadValueAndMarketedProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasWellheadValueAndMarketedProduction", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Wellhead Value and Marketed Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasWellheadValueAndMarketedProduction" + } + }, + "/eia/natural_gas/production/number_of_gas_producing_oil_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Number of Gas Producing Oil Wells. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.number_of_gas_producing_oil_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_number_of_oil_wells", + "alaska_natural_gas_number_of_oil_wells", + "arizona_natural_gas_number_of_oil_wells", + "arkansas_natural_gas_number_of_oil_wells", + "california_natural_gas_number_of_oil_wells", + "colorado_natural_gas_number_of_oil_wells", + "federal_offshore_gulf_of_america_natural_gas_number_of_oil", + "florida_natural_gas_number_of_oil_wells", + "illinois_natural_gas_number_of_oil_wells", + "indiana_natural_gas_number_of_oil_wells", + "kansas_natural_gas_number_of_oil_wells", + "kentucky_natural_gas_number_of_oil_wells", + "louisiana_natural_gas_number_of_oil_wells", + "maryland_natural_gas_number_of_oil_wells", + "michigan_natural_gas_number_of_oil_wells", + "mississippi_natural_gas_number_of_oil_wells", + "missouri_natural_gas_number_of_oil_wells", + "montana_natural_gas_number_of_oil_wells", + "nebraska_natural_gas_number_of_oil_wells", + "nevada_natural_gas_number_of_oil_wells", + "new_mexico_natural_gas_number_of_oil_wells", + "new_york_natural_gas_number_of_oil_wells", + "north_dakota_natural_gas_number_of_oil_wells", + "ohio_natural_gas_number_of_oil_wells", + "oklahoma_natural_gas_number_of_oil_wells", + "oregon_natural_gas_number_of_oil_wells", + "pennsylvania_natural_gas_number_of_oil_wells", + "south_dakota_natural_gas_number_of_oil_wells", + "tennessee_natural_gas_number_of_oil_wells", + "texas_natural_gas_number_of_oil_wells", + "us_natural_gas_number_of_oil_wells", + "utah_natural_gas_number_of_oil_wells", + "virginia_natural_gas_number_of_oil_wells", + "west_virginia_natural_gas_number_of_oil_wells", + "wyoming_natural_gas_number_of_oil_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNumberOfGasProducingOilWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNumberOfGasProducingOilWells", + "openapi_extra": { + "widget_config": { + "name": "Number of Gas Producing Oil Wells", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNumberOfGasProducingOilWells" + } + }, + "/eia/natural_gas/production/number_of_producing_gas_wells": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Number of Producing Gas Wells. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.number_of_producing_gas_wells(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_natural_gas_number_of_gas_and_gas_condensate_wells", + "alaska_natural_gas_number_of_gas_and_gas_condensate_wells", + "arizona_natural_gas_number_of_gas_and_gas_condensate_wells", + "arkansas_natural_gas_number_of_gas_and_gas_condensate_wells", + "california_natural_gas_number_of_gas_and_gas_condensate", + "colorado_natural_gas_number_of_gas_and_gas_condensate_wells", + "federal_offshore_gulf_of_america_natural_gas_number_of_gas", + "florida_natural_gas_number_of_gas_and_gas_condensate_wells", + "idaho_number_of_gas_and_gas_condensate_wells_of_natural_gas", + "illinois_natural_gas_number_of_gas_and_gas_condensate_wells", + "indiana_natural_gas_number_of_gas_and_gas_condensate_wells", + "kansas_natural_gas_number_of_gas_and_gas_condensate_wells", + "kentucky_natural_gas_number_of_gas_and_gas_condensate_wells", + "louisiana_natural_gas_number_of_gas_and_gas_condensate_wells", + "maryland_natural_gas_number_of_gas_and_gas_condensate_wells", + "michigan_natural_gas_number_of_gas_and_gas_condensate_wells", + "mississippi_natural_gas_number_of_gas_and_gas_condensate", + "missouri_natural_gas_number_of_gas_and_gas_condensate_wells", + "montana_natural_gas_number_of_gas_and_gas_condensate_wells", + "nebraska_natural_gas_number_of_gas_and_gas_condensate_wells", + "nevada_natural_gas_number_of_gas_and_gas_condensate_wells", + "new_mexico_natural_gas_number_of_gas_and_gas_condensate", + "new_york_natural_gas_number_of_gas_and_gas_condensate_wells", + "north_dakota_natural_gas_number_of_gas_and_gas_condensate", + "ohio_natural_gas_number_of_gas_and_gas_condensate_wells", + "oklahoma_natural_gas_number_of_gas_and_gas_condensate_wells", + "oregon_natural_gas_number_of_gas_and_gas_condensate_wells", + "pennsylvania_natural_gas_number_of_gas_and_gas_condensate", + "south_dakota_natural_gas_number_of_gas_and_gas_condensate", + "tennessee_natural_gas_number_of_gas_and_gas_condensate_wells", + "texas_natural_gas_number_of_gas_and_gas_condensate_wells", + "us_natural_gas_number_of_gas_and_gas_condensate_wells", + "utah_natural_gas_number_of_gas_and_gas_condensate_wells", + "virginia_natural_gas_number_of_gas_and_gas_condensate_wells", + "west_virginia_natural_gas_number_of_gas_and_gas_condensate", + "wyoming_natural_gas_number_of_gas_and_gas_condensate_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNumberOfProducingGasWells", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNumberOfProducingGasWells", + "openapi_extra": { + "widget_config": { + "name": "Number of Producing Gas Wells", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNumberOfProducingGasWells" + } + }, + "/eia/natural_gas/production/offshore_gross_withdrawals_of_natural_gas": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Offshore Gross Withdrawals of Natural Gas. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.offshore_gross_withdrawals_of_natural_gas(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "gross_withdrawals", + "withdrawals_from_gas_wells", + "withdrawals_from_oil_wells" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "federal_offshore_gulf_of_america_natural_gas_gross_withdrawals_mmcf", + "federal_offshore_gulf_of_america_natural_gas_gross_withdrawals_from_gas_wells_mmcf", + "federal_offshore_gulf_of_america_natural_gas_gross_withdrawals_from_oil_wells_mmcf" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasOffshoreGrossWithdrawalsOfNaturalGas", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasOffshoreGrossWithdrawalsOfNaturalGas", + "openapi_extra": { + "widget_config": { + "name": "Offshore Gross Withdrawals of Natural Gas", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasOffshoreGrossWithdrawalsOfNaturalGas" + } + }, + "/eia/natural_gas/production/shale_gas_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Shale Gas Production. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.shale_gas_production(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ks", + "usa_ky", + "usa_la", + "usa_mi", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_nm", + "usa_ok", + "usa_pa", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama_shale_production", + "alaska_shale_production", + "arkansas_shale_production", + "california_shale_production", + "colorado_shale_production", + "eastern_states_shale_production", + "kansas_shale_production", + "kentucky_shale_production", + "louisiana_shale_production", + "louisiana_north_shale_production", + "louisiana_south_onshore_shale_production", + "lower_48_federal_offshore_shale_production", + "michigan_shale_production", + "mississippi_shale_production", + "montana_shale_production", + "new_mexico_shale_production", + "new_mexico_east_shale_production", + "new_mexico_west_shale_production", + "new_york_shale_production", + "north_dakota_shale_production", + "ohio_shale_production", + "oklahoma_shale_production", + "pennsylvania_shale_production", + "texas_shale_production", + "texas_rrc_district_1_shale_production", + "texas_rrc_district_10_shale_production", + "texas_rrc_district_2_onsh_shale_production", + "texas_rrc_district_3_onsh_shale_production", + "texas_rrc_district_4_onsh_shale_production", + "texas_rrc_district_5_shale_production", + "texas_rrc_district_6_shale_production", + "texas_rrc_district_7b_shale_production", + "texas_rrc_district_7c_shale_production", + "texas_rrc_district_8_shale_production", + "texas_rrc_district_8a_shale_production", + "texas_rrc_district_9_shale_production", + "us_shale_production", + "utah_shale_production", + "virginia_shale_production", + "west_virginia_shale_production", + "western_states_shale_production", + "wyoming_shale_production" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasShaleGasProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasShaleGasProduction", + "openapi_extra": { + "widget_config": { + "name": "Shale Gas Production", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasShaleGasProduction" + } + }, + "/eia/natural_gas/production/supplemental_gas_supplies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Supplemental Gas Supplies. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.production.supplemental_gas_supplies(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasSupplementalGasSupplies", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasSupplementalGasSupplies", + "openapi_extra": { + "widget_config": { + "name": "Supplemental Gas Supplies", + "category": "EIA", + "subCategory": "Production", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasSupplementalGasSupplies" + } + }, + "/eia/natural_gas/storage/lng_storage_additions_and_withdrawals": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Liquefied Natural Gas Additions to and Withdrawals from Storage. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.storage.lng_storage_additions_and_withdrawals(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "lng_storage_additions", + "lng_storage_net_withdrawals", + "lng_storage_withdrawals" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "new_york", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_de", + "usa_ga", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_la", + "usa_md", + "usa_me", + "usa_mo", + "usa_mt", + "usa_nc", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wi", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 123 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasLngStorageAdditionsAndWithdrawals", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasLngStorageAdditionsAndWithdrawals", + "openapi_extra": { + "widget_config": { + "name": "Liquefied Natural Gas Additions to and Withdrawals from Storage", + "category": "EIA", + "subCategory": "Storage", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasLngStorageAdditionsAndWithdrawals" + } + }, + "/eia/natural_gas/storage/underground_natural_gas_storage_by_all_operators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Underground Natural Gas Storage by All Operators. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.storage.underground_natural_gas_storage_by_all_operators(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "total_underground_storage", + "underground_change_in_working_gas", + "underground_storage_base_gas", + "underground_storage_injections", + "underground_storage_net_withdrawals", + "underground_storage_withdrawals", + "underground_storage_working_gas" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "minnesota", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ia", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 329 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUndergroundNaturalGasStorageByAllOperators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUndergroundNaturalGasStorageByAllOperators", + "openapi_extra": { + "widget_config": { + "name": "Underground Natural Gas Storage by All Operators", + "category": "EIA", + "subCategory": "Storage", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUndergroundNaturalGasStorageByAllOperators" + } + }, + "/eia/natural_gas/storage/underground_natural_gas_storage_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Underground Natural Gas Storage Capacity. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.storage.underground_natural_gas_storage_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "count_of_underground_storage_capacity", + "total_underground_storage_capacity", + "working_underground_storage_capacity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "minnesota", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_ia", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_ne", + "usa_nm", + "usa_ok", + "usa_or", + "usa_pa", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 123 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUndergroundNaturalGasStorageCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUndergroundNaturalGasStorageCapacity", + "openapi_extra": { + "widget_config": { + "name": "Underground Natural Gas Storage Capacity", + "category": "EIA", + "subCategory": "Storage", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUndergroundNaturalGasStorageCapacity" + } + }, + "/eia/natural_gas/storage/us_underground_natural_gas_storage_by_storage_type": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Underground Natural Gas Storage by Storage Type. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.storage.us_underground_natural_gas_storage_by_storage_type(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "non_salt_underground_storage_base_gas", + "non_salt_underground_storage_total", + "non_salt_underground_storage_working_gas", + "non_salt_underground_storage_activity_net", + "non_salt_underground_storage_activity_withdraw", + "non_salt_underground_storage_injections", + "salt_underground_storage_base_gas", + "salt_underground_storage_total", + "salt_underground_storage_working_gas", + "salt_underground_storage_activity_injects", + "salt_underground_storage_activity_net", + "salt_underground_storage_activity_withdraw", + "total_underground_storage", + "underground_storage_base_gas", + "underground_storage_injections", + "underground_storage_net_withdrawals", + "underground_storage_withdrawals", + "underground_storage_working_gas" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us_natural_gas_underground_storage_withdrawals", + "us_natural_gas_non_salt_underground_storage_base_gas", + "us_natural_gas_non_salt_underground_storage_total", + "us_natural_gas_non_salt_underground_storage_working_gas", + "us_natural_gas_non_salt_underground_storage_activity_net", + "us_natural_gas_non_salt_underground_storage_activity", + "us_natural_gas_non_salt_underground_storage_injections", + "us_natural_gas_salt_underground_storage_base_gas", + "us_natural_gas_salt_underground_storage_total", + "us_natural_gas_salt_underground_storage_working_gas", + "us_natural_gas_salt_underground_storage_activity_injects", + "us_natural_gas_salt_underground_storage_activity_net", + "us_natural_gas_salt_underground_storage_activity_withdraw", + "us_natural_gas_underground_storage_net_withdrawals", + "us_natural_gas_underground_storage_volume", + "us_total_natural_gas_injections_into_underground_storage", + "us_total_natural_gas_in_underground_storage_base_gas_mmcf", + "us_total_natural_gas_in_underground_storage_working_gas_mmcf" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsUndergroundNaturalGasStorageByStorageType", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsUndergroundNaturalGasStorageByStorageType", + "openapi_extra": { + "widget_config": { + "name": "U.S. Underground Natural Gas Storage by Storage Type", + "category": "EIA", + "subCategory": "Storage", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsUndergroundNaturalGasStorageByStorageType" + } + }, + "/eia/natural_gas/storage/weekly_working_gas_in_underground_storage": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Weekly Working Gas in Underground Storage. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.storage.weekly_working_gas_in_underground_storage(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "non_salt_underground_storage_working_gas", + "salt_underground_storage_working_gas", + "underground_storage_working_gas" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "na" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "weekly_east_region_natural_gas_working_underground_storage", + "weekly_lower_48_states_natural_gas_working_underground", + "weekly_midwest_region_natural_gas_working_underground", + "weekly_mountain_region_natural_gas_working_underground", + "weekly_nonsalt_region_natural_gas_working_underground", + "weekly_pacific_region_natural_gas_working_underground", + "weekly_salt_region_natural_gas_working_underground_storage", + "weekly_south_central_region_natural_gas_working_underground" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasWeeklyWorkingGasInUndergroundStorage", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasWeeklyWorkingGasInUndergroundStorage", + "openapi_extra": { + "widget_config": { + "name": "Weekly Working Gas in Underground Storage", + "category": "EIA", + "subCategory": "Storage", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasWeeklyWorkingGasInUndergroundStorage" + } + }, + "/eia/natural_gas/summary/natural_gas_annual_supply_disposition_by_state": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Annual Supply & Disposition by State. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.summary.natural_gas_annual_supply_disposition_by_state(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "balancing_item", + "dry_production", + "input_supplemental_fuels", + "total_consumption", + "underground_storage_injections", + "underground_storage_withdrawals" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "minnesota", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nd", + "usa_ne", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. There are 104 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasAnnualSupplyDispositionByState", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasAnnualSupplyDispositionByState", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Annual Supply & Disposition by State", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasAnnualSupplyDispositionByState" + } + }, + "/eia/natural_gas/summary/natural_gas_summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Natural Gas Summary. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.summary.natural_gas_summary(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "city_gate_price", + "commercial_consumption", + "delivered_to_consumers", + "dry_production", + "electric_power_consumption", + "electric_power_price", + "exports", + "exports_price", + "extraction_loss", + "gross_withdrawals", + "imports", + "imports_price", + "industrial_consumption", + "industrial_price", + "lng_imports", + "lease_and_plant_fuel_consumption", + "liquefied_natural_gas_exports", + "liquefied_natural_gas_exports_price", + "liquefied_natural_gas_imports", + "marketed_production", + "pipeline_exports", + "pipeline_exports_price", + "pipeline_fuel_consumption", + "pipeline_imports", + "pipeline_imports_price", + "price_delivered_to_commercial_sectors", + "price_delivered_to_residential_consumers", + "removed_from_natural_gas", + "repressuring", + "residential_consumption", + "total_consumption", + "total_underground_storage", + "total_underground_storage_capacity", + "underground_storage_base_gas", + "underground_storage_injections", + "underground_storage_net_withdrawals", + "underground_storage_withdrawals", + "underground_storage_working_gas", + "vehicle_fuel_consumption", + "vented_and_flared", + "wellhead_acquisition_price", + "withdrawals_from_coalbed_wells", + "withdrawals_from_gas_wells", + "withdrawals_from_oil_wells", + "withdrawals_from_shale_gas" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california", + "colorado", + "florida", + "massachusetts", + "minnesota", + "na", + "new_york", + "ohio", + "texas", + "us", + "usa_ak", + "usa_al", + "usa_ar", + "usa_az", + "usa_ct", + "usa_dc", + "usa_de", + "usa_ga", + "usa_hi", + "usa_ia", + "usa_id", + "usa_il", + "usa_in", + "usa_ks", + "usa_ky", + "usa_la", + "usa_md", + "usa_me", + "usa_mi", + "usa_mo", + "usa_ms", + "usa_mt", + "usa_nc", + "usa_nd", + "usa_ne", + "usa_nh", + "usa_nj", + "usa_nm", + "usa_nv", + "usa_ok", + "usa_or", + "usa_pa", + "usa_ri", + "usa_sc", + "usa_sd", + "usa_tn", + "usa_ut", + "usa_va", + "usa_vt", + "usa_wi", + "usa_wv", + "usa_wy", + "washington" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasNaturalGasSummary", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasNaturalGasSummary", + "openapi_extra": { + "widget_config": { + "name": "Natural Gas Summary", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasNaturalGasSummary" + } + }, + "/eia/natural_gas/summary/us_natural_gas_monthly_supply_and_disposition_balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Natural Gas Monthly Supply and Disposition Balance. EIA natural gas survey data", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.natural_gas.summary.us_natural_gas_monthly_supply_and_disposition_balance(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None | list[str | None]", + "description": "Process filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "balancing_item", + "dry_production", + "extraction_loss", + "gross_withdrawals", + "input_supplemental_fuels", + "marketed_production", + "net_imports", + "net_withdrawals_from_storage", + "total_consumption" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "DuoArea filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "us" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "balancing_item", + "us_dry_natural_gas_production", + "us_natural_gas_gross_withdrawals", + "us_natural_gas_marketed_production", + "us_natural_gas_net_imports", + "us_natural_gas_net_withdrawals_from_storage", + "us_natural_gas_plant_liquids_production_gaseous_equivalent", + "us_natural_gas_total_consumption", + "us_supplemental_gaseous_fuels" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNaturalGasUsNaturalGasMonthlySupplyAndDispositionBalance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "process", + "type": "str | None", + "description": "Process code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "process_name", + "type": "str | None", + "description": "Process name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "DuoArea code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "DuoArea name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNaturalGasUsNaturalGasMonthlySupplyAndDispositionBalance", + "openapi_extra": { + "widget_config": { + "name": "U.S. Natural Gas Monthly Supply and Disposition Balance", + "category": "EIA", + "subCategory": "Summary", + "source": [ + "EIA" + ] + }, + "model": "EiaNaturalGasUsNaturalGasMonthlySupplyAndDispositionBalance" + } + }, + "/eia/electricity/electric_power_operations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Electric Power Operations (Annual and Monthly). Monthly and annual electric power operations by state, sector, and energy source. Source: Form EIA-923", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity.electric_power_operations(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: ash_content = Average Ash Content of Consumed Fuel; consumption_for_eg = Consumption of Fuels for Electricity Generation (Physical Units); consumption_for_eg_btu = Consumption of Fuels for Electricity Generation (BTUs); consumption_uto = Consumption of Fuels for Useful Thermal Output (Physical Units); consumption_uto_btu = Consumption of Fuels for Useful Thermal Output (BTUs); cost = Average Cost of Fuels (per Physical Unit); cost_per_btu = Average Cost of Fuels (per BTU); generation = Utility Scale Electricity Net Generation; heat_content = Average Heat Content of Consumed Fuels; receipts = Receipts of Fuel (Physical Units); receipts_btu = Receipts of Fuel (BTUs); stocks = Stocks of Fuel (Physical Units); sulfur_content = Average Sulfur Content of Consumed Fuel; total_consumption = Consumption of Fuels for Electricity Generation and Useful Thermal Output (Physical Units); total_consumption_btu = Consumption of Fuels for Electricity Generation and Useful Thermal Output (BTUs). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ash_content", + "consumption_for_eg", + "consumption_for_eg_btu", + "consumption_uto", + "consumption_uto_btu", + "cost", + "cost_per_btu", + "generation", + "heat_content", + "receipts", + "receipts_btu", + "stocks", + "sulfur_content", + "total_consumption", + "total_consumption_btu" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "fuel", + "type": "str | None | list[str | None]", + "description": "Energy Source filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_coal_products", + "all_fuels", + "all_renewables", + "anthracite_coal", + "biogenic_municipal_solid_waste", + "biomass", + "bituminous_coal", + "bituminous_coal_and_synthetic_coal", + "coal_excluding_waste_coal", + "conventional_hydroelectric", + "distillate_fuel_oil", + "estimated_small_scale_solar_photovoltaic", + "estimated_total_solar", + "estimated_total_solar_photovoltaic", + "fossil_fuels", + "geothermal", + "hydro_electric_pumped_storage", + "landfill_gas", + "lignite_coal", + "municiapl_landfill_gas", + "natural_gas", + "natural_gas_and_other_gases", + "nuclear", + "offshore_wind_turbine", + "onshore_wind_turbine", + "other", + "other_gases", + "other_renewables", + "petroleum", + "petroleum_coke", + "petroleum_liquids", + "refined_coal", + "renewable", + "renewable_waste_products", + "residual_fuel_oil", + "solar", + "solar_photovoltaic", + "solar_thermal", + "subbituminous_coal", + "waste_coal", + "waste_oil_and_other_oils", + "wind", + "wood_and_wood_wastes" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "Sector filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_commercial", + "all_industrial", + "all_sectors", + "coal_consumption", + "commercial_chp", + "commercial_non_chp", + "electric_power", + "electric_power_sector_non_chp", + "electric_utility", + "ipp_chp", + "ipp_non_chp", + "independent_power_producers", + "industrial_chp", + "industrial_non_chp", + "residential" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State / Census Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "east_north_central", + "east_south_central", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "middle_atlantic", + "minnesota", + "mississippi", + "missouri", + "montana", + "mountain", + "nebraska", + "nevada", + "new_england", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pacific", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "puerto_rico", + "rhode_island", + "south_atlantic", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "us_total", + "utah", + "vermont", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityElectricPowerOperations", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel", + "type": "str | None", + "description": "Energy Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_name", + "type": "str | None", + "description": "Energy Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "Sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State / Census Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State / Census Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ash_content", + "type": "float | None", + "description": "Average Ash Content of Consumed Fuel. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_for_eg", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_for_eg_btu", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation (BTUs). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_uto", + "type": "float | None", + "description": "Consumption of Fuels for Useful Thermal Output (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_uto_btu", + "type": "float | None", + "description": "Consumption of Fuels for Useful Thermal Output (BTUs). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cost", + "type": "float | None", + "description": "Average Cost of Fuels (per Physical Unit). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cost_per_btu", + "type": "float | None", + "description": "Average Cost of Fuels (per BTU). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generation", + "type": "float | None", + "description": "Utility Scale Electricity Net Generation. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "heat_content", + "type": "float | None", + "description": "Average Heat Content of Consumed Fuels. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receipts", + "type": "float | None", + "description": "Receipts of Fuel (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receipts_btu", + "type": "float | None", + "description": "Receipts of Fuel (BTUs). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stocks", + "type": "float | None", + "description": "Stocks of Fuel (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfur_content", + "type": "float | None", + "description": "Average Sulfur Content of Consumed Fuel. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_consumption", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation and Useful Thermal Output (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_consumption_btu", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation and Useful Thermal Output (BTUs). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityElectricPowerOperations", + "openapi_extra": { + "widget_config": { + "name": "Electric Power Operations (Annual and Monthly)", + "category": "EIA", + "subCategory": "Electricity", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityElectricPowerOperations" + } + }, + "/eia/electricity/electric_power_operations_for_individual_power_plants": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Electric Power Operations for Individual Power Plants (Annual and Monthly). Annual and monthly electric power operations for individual power plants, by energy source and prime mover Source: Form EIA-923", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity.electric_power_operations_for_individual_power_plants(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_heat_content = Average Heat Content of Consumed Fuels; consumption_for_eg = Consumption of Fuels for Electricity Generation (Physical Units); consumption_for_eg_btu = Consumption of Fuels for Electricity Generation (BTUs) (MMBtu); generation = Net Generation (megawatthours); gross_generation (megawatthours); total_consumption = Consumption of Fuels for Electricity Generation and Useful Thermal Output (Physical Units); total_consumption_btu = Consumption of Fuels for Electricity Generation and Useful Thermal Output (BTUs) (MMBtu). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_heat_content", + "consumption_for_eg", + "consumption_for_eg_btu", + "generation", + "gross_generation", + "total_consumption", + "total_consumption_btu" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "fuel", + "type": "str | None | list[str | None]", + "description": "2002 Fuel Source filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "agricultural_by_products", + "anthracite_coal", + "bituminous_coal", + "black_liquor", + "blast_furnace_gas", + "coal_synfuel", + "coal_derived_synthesis_gas", + "distillate_fuel_oil", + "electricity_used_for_energy_storage", + "gaseous_propane", + "geothermal", + "hydrogen", + "jet_fuel", + "kerosene", + "landfill_gas", + "lignite_coal", + "municipal_solid_waste", + "municipal_solid_waste_biogenic", + "municipal_solid_waste_non_biogenic", + "natural_gas", + "nuclear", + "other", + "other_biomass_gas", + "other_biomass_liquids", + "other_biomass_solids", + "other_gas", + "other_gases", + "petroleum_coke", + "purchased_steam", + "refined_coal", + "residual_fuel_oil", + "sludge_waste", + "solar", + "subbituminous_coal", + "synthesis_gas_from_petroleum_coke", + "tire_derived_fuels", + "total", + "waste_coal", + "waste_heat", + "waste_oil", + "water", + "wind", + "wood_waste_liquids", + "wood_wood_waste" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type", + "type": "str | None | list[str | None]", + "description": "Fuel Source filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "coal", + "distillate_fuel_oil", + "geothermal", + "hydroelectric_conventional", + "hydroelectric_pumped_storage", + "municiapl_landfill_gas", + "natural_gas", + "nuclear", + "other", + "other_gases", + "petroleum_coke", + "residual_fuel_oil", + "solar", + "total", + "waste_coal", + "waste_oil_and_other_oils", + "wind", + "wood_waste_solids", + "other_renewables" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None | list[str | None]", + "description": "Plant ID and Name filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "prime_mover", + "type": "str | None | list[str | None]", + "description": "Prime Mover filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "value", + "all", + "ba", + "bt", + "ca", + "cc", + "ce", + "cp", + "cs", + "ct", + "fc", + "fw", + "gt", + "hy", + "ic", + "ot", + "ps", + "pv", + "st", + "ws", + "wt" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "none", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "puerto_rico", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityElectricPowerOperationsForIndividualPowerPlants", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel", + "type": "str | None", + "description": "2002 Fuel Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_name", + "type": "str | None", + "description": "2002 Fuel Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type", + "type": "str | None", + "description": "Fuel Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type_name", + "type": "str | None", + "description": "Fuel Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None", + "description": "Plant ID and Name code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_name", + "type": "str | None", + "description": "Plant ID and Name name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prime_mover", + "type": "str | None", + "description": "Prime Mover code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prime_mover_name", + "type": "str | None", + "description": "Prime Mover name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_heat_content", + "type": "float | None", + "description": "Average Heat Content of Consumed Fuels. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_for_eg", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_for_eg_btu", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation (BTUs) (MMBtu). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generation", + "type": "float | None", + "description": "Net Generation (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_generation", + "type": "float | None", + "description": "Gross Generation (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_consumption", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation and Useful Thermal Output (Physical Units). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_consumption_btu", + "type": "float | None", + "description": "Consumption of Fuels for Electricity Generation and Useful Thermal Output (BTUs) (MMBtu). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityElectricPowerOperationsForIndividualPowerPlants", + "openapi_extra": { + "widget_config": { + "name": "Electric Power Operations for Individual Power Plants (Annual and Monthly)", + "category": "EIA", + "subCategory": "Electricity", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityElectricPowerOperationsForIndividualPowerPlants" + } + }, + "/eia/electricity/electricity_sales_to_ultimate_customers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Electricity Sales to Ultimate Customers. Electricity sales to ultimate customer by state and sector (number of customers, average price, revenue, and megawatthours of sales). Sources: Forms EIA-826, EIA-861, EIA-861M", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity.electricity_sales_to_ultimate_customers(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: customers = Number of Ultimate Customers (number of customers); price = Average Price of Electricity to Ultimate Customers (cents per kilowatt-hour); revenue = Revenue from Sales to Ultimate Customers (million dollars); sales = Megawatt-hours Sold to Ultimate Customers (million kilowatt hours). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "customers", + "price", + "revenue", + "sales" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "Sector filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_sectors", + "commercial", + "industrial", + "other", + "residential", + "transportation" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State / Census Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "east_north_central", + "east_south_central", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "middle_atlantic", + "minnesota", + "mississippi", + "missouri", + "montana", + "mountain", + "nebraska", + "nevada", + "new_england", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pacific_contiguous", + "pacific_noncontiguous", + "pennsylvania", + "rhode_island", + "south_atlantic", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "us_total", + "utah", + "vermont", + "virginia", + "washington", + "west_north_central", + "west_south_central", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityElectricitySalesToUltimateCustomers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "sector", + "type": "str | None", + "description": "Sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "Sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State / Census Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State / Census Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customers", + "type": "float | None", + "description": "Number of Ultimate Customers (number of customers). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Average Price of Electricity to Ultimate Customers (cents per kilowatt-hour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue", + "type": "float | None", + "description": "Revenue from Sales to Ultimate Customers (million dollars). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales", + "type": "float | None", + "description": "Megawatt-hours Sold to Ultimate Customers (million kilowatt hours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityElectricitySalesToUltimateCustomers", + "openapi_extra": { + "widget_config": { + "name": "Electricity Sales to Ultimate Customers", + "category": "EIA", + "subCategory": "Electricity", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityElectricitySalesToUltimateCustomers" + } + }, + "/eia/electricity/inventory_of_operable_generators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Inventory of Operable Generators. Inventory of operable generators in the U.S. Source: Forms EIA-860, EIA-860M", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity.inventory_of_operable_generators(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: county; latitude; longitude; nameplate_capacity_mw = Nameplate Capacity (MW); net_summer_capacity_mw = Net Summer Capacity (MW); net_winter_capacity_mw = Net Winter Capacity (MW); operating_year_month = Operating Date (Year and Month); planned_derate_summer_cap_mw = Magnitude of Planned Derate (Summer Capacity) (MW); planned_derate_year_month = Planned Derate Date (Year and Month); planned_retirement_year_month = Planned Retirement Date (Year and Month); planned_uprate_summer_cap_mw = Magnitude of Planned Uprate (Summer Capacity) (MW); planned_uprate_year_month = Planned Uprate Date (Year and Month). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "county", + "latitude", + "longitude", + "nameplate_capacity_mw", + "net_summer_capacity_mw", + "net_winter_capacity_mw", + "operating_year_month", + "planned_derate_summer_cap_mw", + "planned_derate_year_month", + "planned_retirement_year_month", + "planned_uprate_summer_cap_mw", + "planned_uprate_year_month" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "balancing_authority", + "type": "str | None | list[str | None]", + "description": "Balancing Authority filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alcoa_power_generating_yadkin_division", + "american_electric_power_service_corp_as_agent_for_public", + "arizona_public_service_company", + "arlington_valley_avba", + "associated_electric_cooperative", + "avangrid_renewables", + "avista_corporation", + "balancing_authority_of_northern_california", + "board_of_public_utilities", + "bonneville_power_administration", + "california_independent_system_operator", + "chugach_electric_assn", + "city_utilities_of_springfield_mo", + "city_of_homestead", + "city_of_tacoma_department_of_public_utilities_light_division", + "city_of_tallahassee", + "constellation_energy_control_and_dispatch", + "dominion_energy_south_carolina", + "duke_energy_carolinas", + "duke_energy_progress_west", + "el_paso_electric_company", + "electric_energy", + "electric_reliability_council_of_texas", + "florida_municipal_power_pool", + "florida_power_and_light_company", + "gainesville_regional_utilities", + "gila_river_power", + "grand_river_dam_authority", + "gridliance", + "gridforce_energy_management", + "gridforce_south", + "griffith_energy", + "hawaiian_electric_co", + "iso_new_england", + "idaho_power_company", + "imperial_irrigation_district", + "independence_power_and_light", + "jea", + "kcpl_greater_missouri_operations", + "kansas_city_power_and_light_company", + "lg_and_e_and_ku_services_company_as_agent_for_louisville", + "lincoln_electric_system", + "los_angeles_department_of_water_and_power", + "midcontinent_independent_transmission_system_operator", + "naturener_power_watch", + "naturener_wind_watch", + "nebraska_public_power_district", + "nevada_power_company", + "new_brunswick_system_operator", + "new_harquahala_generating_company_hgba", + "new_smyrna_beach_utilities_commission_of", + "new_york_independent_system_operator", + "no_ba", + "northwestern_energy", + "ohio_valley_electric_corporation", + "oklahoma_gas_and_electric_co", + "omaha_public_power_district", + "pjm_interconnection", + "pud_no_1_of_douglas_county", + "pacificorp_east", + "pacificorp_west", + "portland_general_electric_company", + "powersouth_energy_cooperative", + "progress_energy_carolinas_east", + "progress_energy_florida", + "public_service_company_of_colorado", + "public_service_company_of_new_mexico", + "public_utility_district_no_1_of_chelan_county", + "public_utility_district_no_2_of_grant_county_washington", + "puget_sound_energy", + "salt_river_project", + "seattle_city_light", + "seminole_electric_cooperative", + "south_carolina_electric_and_amp_gas_company", + "southeastern_power_administration", + "southern_company_services_trans", + "southwest_power_pool", + "southwestern_power_administration", + "southwestern_public_service_co", + "sunflower_electric_power_corporation", + "tampa_electric_company", + "tennessee_valley_authority", + "the_empire_district_electric_company", + "tucson_electric_power_company", + "turlock_irrigation_district", + "westar_energy", + "western_area_power_administration_desert_southwest_region", + "western_area_power_administration_rocky_mountain_region", + "western_area_power_administration_upper_great_plains_east", + "western_area_power_administration_ugp_west", + "western_farmers_electric_cooperative" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "energy_source", + "type": "str | None | list[str | None]", + "description": "Primary Energy Source filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "value", + "agriculture_byproducts", + "bituminous_coal", + "black_liquor", + "blast_furnace_gas", + "coal_derived_synthesis_gas", + "disillate_fuel_oil", + "electricity_used_for_energy_storage", + "gaseous_propane", + "geothermal", + "jet_fuel", + "kerosene", + "landfill_gas", + "lignite", + "municipal_solid_waste", + "natural_gas", + "nuclear", + "other", + "other_biomass_gases", + "other_biomass_liquids", + "other_biomass_solids", + "other_gas", + "petroleum_coke", + "purchased_steam", + "refined_coal", + "residual_fuel_oil", + "sludge_waste", + "solar", + "subbituminous_coal", + "synthesis_gas_from_petroleum_coke", + "tire_derived_fuel", + "waste_coal", + "waste_heat", + "waste_oil", + "water", + "wind", + "wood_waste_liquids", + "wood_waste_solids" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "entity", + "type": "str | None | list[str | None]", + "description": "Entity ID and Name filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "generator", + "type": "str | None | list[str | None]", + "description": "Generator ID filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None | list[str | None]", + "description": "Plant ID and Name filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "prime_mover", + "type": "str | None | list[str | None]", + "description": "Prime Mover Code filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "ba", + "bt", + "ca", + "ce", + "cp", + "cs", + "ct", + "fc", + "fw", + "gt", + "hy", + "ic", + "ot", + "ps", + "pv", + "st", + "ws", + "wt" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "Sector filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "commercial_chp", + "commercial_non_chp", + "electric_utility", + "ipp_chp", + "ipp_non_chp", + "industrial_chp", + "industrial_non_chp" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None | list[str | None]", + "description": "Operating Status Code filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "operating", + "out_of_service_and_not_expected_to_return_to_service_in", + "out_of_service_but_expected_to_return_to_service_in_next", + "standby_backup_available_for_service_but_not_normally_used" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "technology", + "type": "str | None | list[str | None]", + "description": "Technology filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_other", + "batteries", + "coal_integrated_gasification_combined_cycle", + "conventional_hydroelectric", + "conventional_steam_coal", + "flywheels", + "geothermal", + "hydroelectric_pumped_storage", + "landfill_gas", + "municipal_solid_waste", + "natural_gas_fired_combined_cycle", + "natural_gas_fired_combustion_turbine", + "natural_gas_internal_combustion_engine", + "natural_gas_steam_turbine", + "natural_gas_with_compressed_air_storage", + "nuclear", + "offshore_wind_turbine", + "onshore_wind_turbine", + "other_gases", + "other_natural_gas", + "other_waste_biomass", + "petroleum_coke", + "petroleum_liquids", + "solar_photovoltaic", + "solar_thermal_with_energy_storage", + "solar_thermal_without_energy_storage", + "wood_wood_waste_biomass" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None | list[str | None]", + "description": "Unit Code filter. Accepts a comma-separated list of values. There are 385 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityInventoryOfOperableGenerators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "balancing_authority", + "type": "str | None", + "description": "Balancing Authority code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balancing_authority_name", + "type": "str | None", + "description": "Balancing Authority name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "energy_source", + "type": "str | None", + "description": "Primary Energy Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "energy_source_name", + "type": "str | None", + "description": "Primary Energy Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity", + "type": "str | None", + "description": "Entity ID and Name code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_name", + "type": "str | None", + "description": "Entity ID and Name name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generator", + "type": "str | None", + "description": "Generator ID code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generator_name", + "type": "str | None", + "description": "Generator ID name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant", + "type": "str | None", + "description": "Plant ID and Name code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "plant_name", + "type": "str | None", + "description": "Plant ID and Name name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prime_mover", + "type": "str | None", + "description": "Prime Mover Code code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prime_mover_name", + "type": "str | None", + "description": "Prime Mover Code name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "Sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "Operating Status Code code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status_name", + "type": "str | None", + "description": "Operating Status Code name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "technology", + "type": "str | None", + "description": "Technology code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "technology_name", + "type": "str | None", + "description": "Technology name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit Code code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit_name", + "type": "str | None", + "description": "Unit Code name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "county", + "type": "str | None", + "description": "County", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "Latitude. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "Longitude. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nameplate_capacity_mw", + "type": "float | None", + "description": "Nameplate Capacity (MW). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_summer_capacity_mw", + "type": "float | None", + "description": "Net Summer Capacity (MW). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_winter_capacity_mw", + "type": "float | None", + "description": "Net Winter Capacity (MW). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_year_month", + "type": "str | None", + "description": "Operating Date (Year and Month)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "planned_derate_summer_cap_mw", + "type": "float | None", + "description": "Magnitude of Planned Derate (Summer Capacity) (MW). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "planned_derate_year_month", + "type": "str | None", + "description": "Planned Derate Date (Year and Month)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "planned_retirement_year_month", + "type": "str | None", + "description": "Planned Retirement Date (Year and Month)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "planned_uprate_summer_cap_mw", + "type": "float | None", + "description": "Magnitude of Planned Uprate (Summer Capacity) (MW). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "planned_uprate_year_month", + "type": "str | None", + "description": "Planned Uprate Date (Year and Month)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityInventoryOfOperableGenerators", + "openapi_extra": { + "widget_config": { + "name": "Inventory of Operable Generators", + "category": "EIA", + "subCategory": "Electricity", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityInventoryOfOperableGenerators" + } + }, + "/eia/electricity_grid/demand": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Hourly Demand, Demand Forecast, Generation, and Interchange. Hourly demand, day-ahead demand forecast, net generation, and interchange by balancing authority. Source: Form EIA-930 Product: Hourly Electric Grid Monitor", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity_grid.demand(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'hourly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "respondent", + "type": "str | None | list[str | None]", + "description": "Balancing Authority / Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alcoa_power_generating_yadkin_division", + "arizona_public_service_company", + "arlington_valley", + "associated_electric_cooperative", + "avangrid_renewables", + "avista_corporation", + "balancing_authority_of_northern_california", + "bonneville_power_administration", + "california", + "california_independent_system_operator", + "carolinas", + "central", + "city_of_homestead", + "city_of_tacoma_department_of_public_utilities_light_division", + "city_of_tallahassee", + "dominion_energy_south_carolina", + "duke_energy_carolinas", + "duke_energy_florida", + "duke_energy_progress_east", + "duke_energy_progress_west", + "el_paso_electric_company", + "electric_energy", + "electric_reliability_council_of_texas", + "florida", + "florida_municipal_power_pool", + "florida_power_and_light_co", + "gainesville_regional_utilities", + "gridliance", + "gridforce_energy_management", + "griffith_energy", + "iso_new_england", + "idaho_power_company", + "imperial_irrigation_district", + "jea", + "lg_and_e_and_ku_services_company_as_agent_for_louisville", + "los_angeles_department_of_water_and_power", + "mid_atlantic", + "midcontinent_independent_system_operator", + "midwest", + "naturener_power_watch", + "naturener_wind_watch", + "nevada_power_company", + "new_england", + "new_harquahala_generating_company", + "new_york", + "new_york_independent_system_operator", + "northwestern_corporation", + "northwest", + "pjm_interconnection", + "pud_no_1_of_douglas_county", + "pacificorp_east", + "pacificorp_west", + "portland_general_electric_company", + "powersouth_energy_cooperative", + "public_service_company_of_colorado", + "public_service_company_of_new_mexico", + "public_utility_district_no_1_of_chelan_county", + "public_utility_district_no_2_of_grant_county_washington", + "puget_sound_energy", + "salt_river_project_agricultural_improvement_and_power", + "seattle_city_light", + "seminole_electric_cooperative", + "sikeston_board_of_municipal_utilities", + "south_carolina_public_service_authority", + "southeast", + "southeastern_power_administration", + "southern_company_services_trans", + "southwest", + "southwest_power_pool", + "southwestern_power_administration", + "tampa_electric_company", + "tennessee", + "tennessee_valley_authority", + "texas", + "tucson_electric_power", + "turlock_irrigation_district", + "united_states_lower_48", + "utilities_commission_of_new_smyrna_beach", + "western_area_power_administration_desert_southwest_region", + "western_area_power_administration_rocky_mountain_region", + "western_area_power_administration_upper_great_plains_west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series_type", + "type": "str | None | list[str | None]", + "description": "Metric filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "day_ahead_demand_forecast", + "demand", + "net_generation", + "total_interchange" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None | list[str | None]", + "description": "Time Zone for Determining Date filter. Only applies to frequency: daily. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arizona", + "central", + "eastern", + "mountain", + "pacific" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityGridDemand", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "respondent", + "type": "str | None", + "description": "Balancing Authority / Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "respondent_name", + "type": "str | None", + "description": "Balancing Authority / Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_type", + "type": "str | None", + "description": "Metric code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_type_name", + "type": "str | None", + "description": "Metric name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None", + "description": "Time Zone for Determining Date code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone_name", + "type": "str | None", + "description": "Time Zone for Determining Date name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Demand, Demand Forecast, Net Generation, or Interchange (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityGridDemand", + "openapi_extra": { + "widget_config": { + "name": "Hourly Demand, Demand Forecast, Generation, and Interchange", + "category": "EIA", + "subCategory": "Electric Power Operations (Daily and Hourly)", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityGridDemand" + } + }, + "/eia/electricity_grid/demand_by_subregion": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Hourly Demand by Subregion. Hourly demand by balancing authority subregion. Source: Form EIA-930 Product: Hourly Electric Grid Monitor", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity_grid.demand_by_subregion(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'hourly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "parent", + "type": "str | None | list[str | None]", + "description": "Balancing Authority filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "california_independent_system_operator", + "electric_reliability_council_of_texas", + "iso_new_england", + "midcontinent_independent_system_operator", + "new_york_independent_system_operator", + "pjm_interconnection", + "public_service_company_of_new_mexico", + "southwest_power_pool" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "subregion", + "type": "str | None | list[str | None]", + "description": "Subregion filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aepw_american_electric_power_west", + "allegheny_power_zone_pjm", + "american_electric_power_zone", + "american_transmission_systems_zone_pjm", + "atlantic_electric_zone", + "baltimore_gas_null_zone_pjm", + "capital_nyis", + "central_nyis", + "city_of_acoma_pueblo_pnm", + "city_of_gallup", + "city_of_springfield", + "commonwealth_edison_zone", + "connecticut", + "dayton_power_null_zone_pjm", + "delmarva_power_null_zone_pjm", + "dominion_virginia_power_zone", + "duke_energy_ohio_kentucky_zone_pjm", + "dunwoodie_nyis", + "duquesne_lighting_company_zone", + "erco_coast", + "erco_far_west", + "erco_north_central", + "erco_south_central", + "east", + "east_kentucky_power_cooperative_zone_pjm", + "empire_district_electric_company", + "freeport", + "genesee_nyis", + "grand_river_dam_authority_swpp", + "hudson_valley", + "isne_northeast_mass", + "isne_vermont", + "independence_power_null_swpp", + "jersey_central_power_null_zone_pjm", + "jicarilla_apache_nation", + "kafb_pnm", + "kcec_pnm", + "kcp_and_l_greater_missouri_operations_swpp", + "kansas_city_board_of_public_utilities_swpp", + "kansas_city_power_and_light", + "lincoln_electric_system", + "long_island_nyis", + "los_alamos_county", + "maine", + "metropolitan_edison_zone_pjm", + "millwood_nyis", + "mohawk_valley_nyis", + "navajo_tribal_utility_authority_pnm", + "nebraska_public_power_district", + "new_hampshire", + "new_york_city_nyis", + "north", + "north_nyis", + "oklahoma_gas_and_electric_co_swpp", + "omaha_public_power_district_swpp", + "peco_energy_zone_pjm", + "pnm_system_firm_load", + "pacific_gas_and_electric", + "pennsylvania_electric_zone_pjm", + "pennsylvania_power_and_light_zone", + "potomac_electric_power_zone", + "public_service_electric_and_gas_of_new_jersey_zone_pjm", + "rhode_island", + "rockland_electric_zone_pjm", + "san_diego_gas_and_electric", + "south", + "southeast_mass", + "southern_california_edison", + "southwestern_public_service_company_swpp", + "sunflower_electric", + "tri_state_generation_and_transmission", + "valley_electric_association_ciso", + "west", + "west_nyis", + "westar_energy", + "western_area_power_upper_great_plains_east", + "western_farmers_electric_cooperative", + "western_central_mass", + "zone_1", + "zone_4_miso", + "zone_6_miso", + "zones_2_and_7", + "zones_3_and_5", + "zones_8_9_and_10_miso" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None | list[str | None]", + "description": "Time Zone for Determining Date filter. Only applies to frequency: daily. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arizona", + "central", + "eastern", + "mountain", + "pacific" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityGridDemandBySubregion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "parent", + "type": "str | None", + "description": "Balancing Authority code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_name", + "type": "str | None", + "description": "Balancing Authority name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subregion", + "type": "str | None", + "description": "Subregion code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subregion_name", + "type": "str | None", + "description": "Subregion name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None", + "description": "Time Zone for Determining Date code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone_name", + "type": "str | None", + "description": "Time Zone for Determining Date name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Demand (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityGridDemandBySubregion", + "openapi_extra": { + "widget_config": { + "name": "Hourly Demand by Subregion", + "category": "EIA", + "subCategory": "Electric Power Operations (Daily and Hourly)", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityGridDemandBySubregion" + } + }, + "/eia/electricity_grid/generation_by_fuel": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Hourly Generation by Energy Source. Hourly net generation by balancing authority and energy source. Source: Form EIA-930 Product: Hourly Electric Grid Monitor", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity_grid.generation_by_fuel(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'hourly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fuel_type", + "type": "str | None | list[str | None]", + "description": "Energy Source filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "battery_storage", + "coal", + "geothermal", + "hydro", + "natural_gas", + "nuclear", + "other", + "other_energy_storage", + "petroleum", + "pumped_storage", + "solar", + "solar_with_integrated_battery_storage", + "unknown", + "unknown_energy", + "wind", + "wind_with_integrated_battery_storage" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "respondent", + "type": "str | None | list[str | None]", + "description": "Balancing Authority / Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alcoa_power_generating_yadkin_division", + "arizona_public_service_company", + "arlington_valley", + "associated_electric_cooperative", + "avangrid_renewables", + "avista_corporation", + "balancing_authority_of_northern_california", + "bonneville_power_administration", + "california", + "california_independent_system_operator", + "carolinas", + "central", + "city_of_homestead", + "city_of_tacoma_department_of_public_utilities_light_division", + "city_of_tallahassee", + "dominion_energy_south_carolina", + "duke_energy_carolinas", + "duke_energy_florida", + "duke_energy_progress_east", + "duke_energy_progress_west", + "el_paso_electric_company", + "electric_energy", + "electric_reliability_council_of_texas", + "florida", + "florida_municipal_power_pool", + "florida_power_and_light_co", + "gainesville_regional_utilities", + "gridliance", + "gridforce_energy_management", + "griffith_energy", + "iso_new_england", + "idaho_power_company", + "imperial_irrigation_district", + "jea", + "lg_and_e_and_ku_services_company_as_agent_for_louisville", + "los_angeles_department_of_water_and_power", + "mid_atlantic", + "midcontinent_independent_system_operator", + "midwest", + "naturener_power_watch", + "naturener_wind_watch", + "nevada_power_company", + "new_england", + "new_harquahala_generating_company", + "new_york", + "new_york_independent_system_operator", + "northwestern_corporation", + "northwest", + "pjm_interconnection", + "pud_no_1_of_douglas_county", + "pacificorp_east", + "pacificorp_west", + "portland_general_electric_company", + "powersouth_energy_cooperative", + "public_service_company_of_colorado", + "public_service_company_of_new_mexico", + "public_utility_district_no_1_of_chelan_county", + "public_utility_district_no_2_of_grant_county_washington", + "puget_sound_energy", + "salt_river_project_agricultural_improvement_and_power", + "seattle_city_light", + "seminole_electric_cooperative", + "sikeston_board_of_municipal_utilities", + "south_carolina_public_service_authority", + "southeast", + "southeastern_power_administration", + "southern_company_services_trans", + "southwest", + "southwest_power_pool", + "southwestern_power_administration", + "tampa_electric_company", + "tennessee", + "tennessee_valley_authority", + "texas", + "tucson_electric_power", + "turlock_irrigation_district", + "united_states_lower_48", + "utilities_commission_of_new_smyrna_beach", + "western_area_power_administration_desert_southwest_region", + "western_area_power_administration_rocky_mountain_region", + "western_area_power_administration_upper_great_plains_west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None | list[str | None]", + "description": "Time Zone for Determining Date filter. Only applies to frequency: daily. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arizona", + "central", + "eastern", + "mountain", + "pacific" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityGridGenerationByFuel", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None", + "description": "Energy Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type_name", + "type": "str | None", + "description": "Energy Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "respondent", + "type": "str | None", + "description": "Balancing Authority / Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "respondent_name", + "type": "str | None", + "description": "Balancing Authority / Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None", + "description": "Time Zone for Determining Date code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone_name", + "type": "str | None", + "description": "Time Zone for Determining Date name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Net Generation (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityGridGenerationByFuel", + "openapi_extra": { + "widget_config": { + "name": "Hourly Generation by Energy Source", + "category": "EIA", + "subCategory": "Electric Power Operations (Daily and Hourly)", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityGridGenerationByFuel" + } + }, + "/eia/electricity_grid/interchange": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Hourly Interchange by Neighboring Balancing Authority. Daily interchange between neighboring balancing authorities. Source: Form EIA-930 Product: Hourly Electric Grid Monitor", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.electricity_grid.interchange(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'hourly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "from_ba", + "type": "str | None | list[str | None]", + "description": "Balancing Authority / Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alcoa_power_generating_yadkin_division", + "arizona_public_service_company", + "arlington_valley", + "associated_electric_cooperative", + "avangrid_renewables", + "avista_corporation", + "balancing_authority_of_northern_california", + "bonneville_power_administration", + "california", + "california_independent_system_operator", + "carolinas", + "central", + "city_of_homestead", + "city_of_tacoma_department_of_public_utilities_light_division", + "city_of_tallahassee", + "dominion_energy_south_carolina", + "duke_energy_carolinas", + "duke_energy_florida", + "duke_energy_progress_east", + "duke_energy_progress_west", + "el_paso_electric_company", + "electric_energy", + "electric_reliability_council_of_texas", + "florida", + "florida_municipal_power_pool", + "florida_power_and_light_co", + "gainesville_regional_utilities", + "gridliance", + "gridforce_energy_management", + "griffith_energy", + "iso_new_england", + "idaho_power_company", + "imperial_irrigation_district", + "jea", + "lg_and_e_and_ku_services_company_as_agent_for_louisville", + "los_angeles_department_of_water_and_power", + "mid_atlantic", + "midcontinent_independent_system_operator", + "midwest", + "naturener_power_watch", + "naturener_wind_watch", + "nevada_power_company", + "new_england", + "new_harquahala_generating_company", + "new_york", + "new_york_independent_system_operator", + "northwestern_corporation", + "northwest", + "pjm_interconnection", + "pud_no_1_of_douglas_county", + "pacificorp_east", + "pacificorp_west", + "portland_general_electric_company", + "powersouth_energy_cooperative", + "public_service_company_of_colorado", + "public_service_company_of_new_mexico", + "public_utility_district_no_1_of_chelan_county", + "public_utility_district_no_2_of_grant_county_washington", + "puget_sound_energy", + "salt_river_project_agricultural_improvement_and_power", + "seattle_city_light", + "seminole_electric_cooperative", + "sikeston_board_of_municipal_utilities", + "south_carolina_public_service_authority", + "southeast", + "southeastern_power_administration", + "southern_company_services_trans", + "southwest", + "southwest_power_pool", + "southwestern_power_administration", + "tampa_electric_company", + "tennessee", + "tennessee_valley_authority", + "texas", + "tucson_electric_power", + "turlock_irrigation_district", + "united_states_lower_48", + "utilities_commission_of_new_smyrna_beach", + "western_area_power_administration_desert_southwest_region", + "western_area_power_administration_rocky_mountain_region", + "western_area_power_administration_upper_great_plains_west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None | list[str | None]", + "description": "Time Zone for Determining Date filter. Only applies to frequency: daily. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arizona", + "central", + "eastern", + "mountain", + "pacific" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "to_ba", + "type": "str | None | list[str | None]", + "description": "Neighboring Balancing Authority / Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alberta_electric_system_operator", + "alcoa_power_generating_yadkin_division", + "arizona_public_service_company", + "arlington_valley", + "associated_electric_cooperative", + "avangrid_renewables", + "avista_corporation", + "balancing_authority_of_northern_california", + "bonneville_power_administration", + "british_columbia_hydro_and_power_authority", + "california", + "california_independent_system_operator", + "canada", + "carolinas", + "central", + "centro_nacional_de_control_de_energia", + "city_of_homestead", + "city_of_tacoma_department_of_public_utilities_light_division", + "city_of_tallahassee", + "dominion_energy_south_carolina", + "duke_energy_carolinas", + "duke_energy_florida", + "duke_energy_progress_east", + "duke_energy_progress_west", + "el_paso_electric_company", + "electric_energy", + "electric_reliability_council_of_texas", + "florida", + "florida_municipal_power_pool", + "florida_power_and_light_co", + "gainesville_regional_utilities", + "gridliance", + "gridforce_energy_management", + "griffith_energy", + "hydro_quebec_transenergie", + "iso_new_england", + "idaho_power_company", + "imperial_irrigation_district", + "jea", + "lg_and_e_and_ku_services_company_as_agent_for_louisville", + "los_angeles_department_of_water_and_power", + "manitoba_hydro", + "mexico", + "mid_atlantic", + "midcontinent_independent_system_operator", + "midwest", + "naturener_power_watch", + "naturener_wind_watch", + "nevada_power_company", + "new_brunswick_system_operator", + "new_england", + "new_harquahala_generating_company", + "new_york", + "new_york_independent_system_operator", + "northwestern_corporation", + "northwest", + "ontario_ieso", + "pjm_interconnection", + "pud_no_1_of_douglas_county", + "pacificorp_east", + "pacificorp_west", + "portland_general_electric_company", + "powersouth_energy_cooperative", + "public_service_company_of_colorado", + "public_service_company_of_new_mexico", + "public_utility_district_no_1_of_chelan_county", + "public_utility_district_no_2_of_grant_county_washington", + "puget_sound_energy", + "salt_river_project_agricultural_improvement_and_power", + "saskatchewan_power_corporation", + "seattle_city_light", + "seminole_electric_cooperative", + "sikeston_board_of_municipal_utilities", + "south_carolina_public_service_authority", + "southeast", + "southeastern_power_administration", + "southern_company_services_trans", + "southwest", + "southwest_power_pool", + "southwestern_power_administration", + "tampa_electric_company", + "tennessee", + "tennessee_valley_authority", + "texas", + "tucson_electric_power", + "turlock_irrigation_district", + "utilities_commission_of_new_smyrna_beach", + "western_area_power_administration_desert_southwest_region", + "western_area_power_administration_rocky_mountain_region", + "western_area_power_administration_upper_great_plains_west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaElectricityGridInterchange", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "from_ba", + "type": "str | None", + "description": "Balancing Authority / Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "from_ba_name", + "type": "str | None", + "description": "Balancing Authority / Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone", + "type": "str | None", + "description": "Time Zone for Determining Date code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timezone_name", + "type": "str | None", + "description": "Time Zone for Determining Date name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "to_ba", + "type": "str | None", + "description": "Neighboring Balancing Authority / Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "to_ba_name", + "type": "str | None", + "description": "Neighboring Balancing Authority / Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Interchange (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaElectricityGridInterchange", + "openapi_extra": { + "widget_config": { + "name": "Hourly Interchange by Neighboring Balancing Authority", + "category": "EIA", + "subCategory": "Electric Power Operations (Daily and Hourly)", + "source": [ + "EIA" + ] + }, + "model": "EiaElectricityGridInterchange" + } + }, + "/eia/state_electricity_profiles/advanced_metering_infrastructure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Advanced Metering Infrastructure. Advanced meterting counts by technology, state, and sector Source: Forms EIA-861, EIA-861S Product: State Electricity Profiles, Table 12", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.advanced_metering_infrastructure(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "sector filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_sectors", + "commercial", + "industrial", + "residential", + "transportation" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "technology", + "type": "str | None | list[str | None]", + "description": "Meter Technology filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "advanced_metering_infrastructure", + "all_meters", + "automated_meter_reading", + "standard_meters" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesAdvancedMeteringInfrastructure", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "sector", + "type": "str | None", + "description": "sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "technology", + "type": "str | None", + "description": "Meter Technology code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "technology_name", + "type": "str | None", + "description": "Meter Technology name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "meters", + "type": "float | None", + "description": "Meter Count (number of meters). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesAdvancedMeteringInfrastructure", + "openapi_extra": { + "widget_config": { + "name": "Advanced Metering Infrastructure", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesAdvancedMeteringInfrastructure" + } + }, + "/eia/state_electricity_profiles/costs_and_savings_from_energy_efficiency_programs": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Costs and Savings from Energy Efficiency Programs. Costs and savings from energy efficiency programs by state and sector Source: Form EIA-861 Product: State Electricity Profiles, Table 13", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.costs_and_savings_from_energy_efficiency_programs(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: all_other_costs (thousand dollars); customer_incentive = Cost of Customer Incentives (thousand dollars); energy_savings = Annual Energy Savings (megawatthours); potential_peak_savings = Peak Demand Savings (megawatts). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_other_costs", + "customer_incentive", + "energy_savings", + "potential_peak_savings" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "Sector filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_sectors", + "commercial", + "industrial", + "residential", + "transportation" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "time_period", + "type": "str | None | list[str | None]", + "description": "Time Period Included in Costs and Savings filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "expected_life_cycle_of_programs", + "reporting_year" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyPrograms", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "sector", + "type": "str | None", + "description": "Sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "Sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "time_period", + "type": "str | None", + "description": "Time Period Included in Costs and Savings code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "time_period_name", + "type": "str | None", + "description": "Time Period Included in Costs and Savings name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "all_other_costs", + "type": "float | None", + "description": "All Other Costs (thousand dollars). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customer_incentive", + "type": "float | None", + "description": "Cost of Customer Incentives (thousand dollars). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "energy_savings", + "type": "float | None", + "description": "Annual Energy Savings (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "potential_peak_savings", + "type": "float | None", + "description": "Peak Demand Savings (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyPrograms", + "openapi_extra": { + "widget_config": { + "name": "Costs and Savings from Energy Efficiency Programs", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesCostsAndSavingsFromEnergyEfficiencyPrograms" + } + }, + "/eia/state_electricity_profiles/electricity_net_metering_customers_and_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Electricity Net Metering: Customers and Capacity. Electricity net metering customer counts and capacity by state, sector, and generating technology. Source: Form EIA-861 Product: State Electricity Profiles, Table 11", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.electricity_net_metering_customers_and_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: capacity (megawatts); customers = Customer Count (number of customers). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "capacity", + "customers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "sector filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "state filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "technology", + "type": "str | None | list[str | None]", + "description": "Technology used to Generate Electricity filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesElectricityNetMeteringCustomersAndCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "sector", + "type": "str | None", + "description": "sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "state code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "state name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "technology", + "type": "str | None", + "description": "Technology used to Generate Electricity code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "technology_name", + "type": "str | None", + "description": "Technology used to Generate Electricity name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity", + "type": "float | None", + "description": "Capacity (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customers", + "type": "float | None", + "description": "Customer Count (number of customers). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesElectricityNetMeteringCustomersAndCapacity", + "openapi_extra": { + "widget_config": { + "name": "Electricity Net Metering: Customers and Capacity", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesElectricityNetMeteringCustomersAndCapacity" + } + }, + "/eia/state_electricity_profiles/emissions_by_state_by_fuel": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Emissions from Energy Consumption at Conventional Power Plants and Combined-Heat-and-Power Plants. Emissions from electricity generation and the production of useful thermal output at conventional power plants and combined-heat-and-power plants. See Electric Power Annual, Technical Notes for a description of the sources and methodology used to develop the emissions estimates. Sources: Forms EIA-860, EIA-923, and calculations made by the Office of Energy Production, Conversion & Delivery (EPCD) Product: State Electricity Profiles, Table 7", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.emissions_by_state_by_fuel(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: co2_rate_lbs_mwh = CO2 Emissions Rate per MWh (pounds per megawatthour); co2_thousand_metric_tons = CO2 Emissions (thousand metric tons); nox_rate_lbs_mwh = NOx Emissions Rate per MWh (pounds per megawatthour); nox_short_tons = NOx Emissions (short tons); so2_rate_lbs_mwh = SO2 Emissions Rate per MWh (pounds per megawatthour); so2_short_tons = SO2 Emissions (short tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "co2_rate_lbs_mwh", + "co2_thousand_metric_tons", + "nox_rate_lbs_mwh", + "nox_short_tons", + "so2_rate_lbs_mwh", + "so2_short_tons" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "fuel", + "type": "str | None | list[str | None]", + "description": "Energy Source filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "coal", + "natural_gas", + "other", + "petroleum", + "total" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesEmissionsByStateByFuel", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel", + "type": "str | None", + "description": "Energy Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_name", + "type": "str | None", + "description": "Energy Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "co2_rate_lbs_mwh", + "type": "float | None", + "description": "CO2 Emissions Rate per MWh (pounds per megawatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "co2_thousand_metric_tons", + "type": "float | None", + "description": "CO2 Emissions (thousand metric tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nox_rate_lbs_mwh", + "type": "float | None", + "description": "NOx Emissions Rate per MWh (pounds per megawatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nox_short_tons", + "type": "float | None", + "description": "NOx Emissions (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "so2_rate_lbs_mwh", + "type": "float | None", + "description": "SO2 Emissions Rate per MWh (pounds per megawatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "so2_short_tons", + "type": "float | None", + "description": "SO2 Emissions (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesEmissionsByStateByFuel", + "openapi_extra": { + "widget_config": { + "name": "Emissions from Energy Consumption at Conventional Power Plants and Combined-Heat-and-Power Plants", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesEmissionsByStateByFuel" + } + }, + "/eia/state_electricity_profiles/generating_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Generating Capacity. Electric generating capacity (summer capacity) by state, energy source, and sector. Source: Form EIA-860 Product: State Electricity Profiles, Table 4", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.generating_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "energy_source", + "type": "str | None | list[str | None]", + "description": "Energy Source filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "battery", + "coal", + "geothermal", + "hydroelectric", + "natural_gas", + "natural_gas_cc", + "natural_gas_gt", + "natural_gas_ic", + "natural_gas_oth", + "natural_gas_st", + "nuclear", + "other", + "other_biomass", + "other_gas", + "petroleum", + "petroleum_gt", + "petroleum_ic", + "petroleum_oth", + "petroleum_st", + "pumped_storage", + "solar", + "solar_pv", + "solar_th", + "wind", + "wood" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "producer_type", + "type": "str | None | list[str | None]", + "description": "Sector filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all_sectors", + "electric_utilities", + "independent_power_producers" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesGeneratingCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "energy_source", + "type": "str | None", + "description": "Energy Source code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "energy_source_name", + "type": "str | None", + "description": "Energy Source name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_type", + "type": "str | None", + "description": "Sector code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "producer_type_name", + "type": "str | None", + "description": "Sector name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capability", + "type": "float | None", + "description": "Net Summer Capacity (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesGeneratingCapacity", + "openapi_extra": { + "widget_config": { + "name": "Generating Capacity", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesGeneratingCapacity" + } + }, + "/eia/state_electricity_profiles/state_rankings_for_key_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "State Rankings for Key Statistics. State rankings for key electricity statistics by state Source: Forms EIA-860, EIA-861, EIA-923 Product: State Electricity Profiles, Table 1", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.state_rankings_for_key_statistics(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_retail_price = Average Retail Price of Electricity (cents per kilowatthour); average_retail_price_rank = Average Retail Price of Electricity (U.S. Rank) (rank); capacity_elec_utilities = Net Summer Capacity, Electric Power Sector (megawatts); capacity_elect_utilities_rank = Average Retail Price of Electricity (U.S. Rank) (rank); capacity_ipp = Net Summer Capacity, Independent Power Producers and Industrial / Commercial Sectors (megawatts); capacity_ipp_rank = Net Summer Capacity, Independent Power Producers and Industrial / Commercial Sectors (U.S. Rank) (rank); carbon_dioxide = CO2 Emissions (thousand metric tons); carbon_dioxide_lbs = CO2 Emissions Rate per MWh (pounds per megawatthour); carbon_dioxide_rank = CO2 Emissions (U.S. Rank) (rank); carbon_dioxide_rank_lbs = CO2 Emissions Rate per MWh (U.S. Rank) (rank); direct_use = Direct Use of Generation by Commercial and Industrial Facilities (megawatthours); direct_use_rank = Direct Use of Generation by Commercial and Industrial Facilities (U.S. Rank) (rank); eop_sales = Retail Sales of Electrcity by Energy-Only Providers (megawatthours); eop_sales_rank = Retail Sales of Electrcity by Energy-Only Providers (U.S. Rank) (rank); fsp_sales_rank = Retail Sales of Electrcity by Full Service Providers and Electricity Sold Directly by Commercial and Industrial Facilities (U.S. Rank) (rank); fsp_service_provider_sales = Retail Sales of Electrcity by Full Service Providers and Electricity Sold Directly by Commercial and Industrial Facilities (megawatthours); generation_elect_utils = Net Generation, Electric Power Sector (megawatthours); generation_elect_utils_rank = Net Generation, Electric Power Sector (U.S. Rank) (rank); generation_ipp = Net Generation, Independent Power Producers and Industrial / Commercial Sectors (megawatthours); generation_ipp_rank = Net Generation, Independent Power Producers and Industrial / Commercial Sectors (U.S. Rank) (rank); net_generation = Net Generation, All Sectors (megawatthours); net_generation_rank = Net Generation, All Sectors (U.S. Rank) (rank); net_summer_capacity = Net Summer Capacity, All Sectors (megawatts); net_summer_capacity_rank = Net Summer Capacity, All Sectors (U.S. Rank) (rank); nitrogen_oxide = NOx Emissions (short tons); nitrogen_oxide_lbs = NOx Emissions Rate per MWh (pounds per megawatthour); nitrogen_oxide_rank = NOx Emissions (U.S. Rank) (rank); nitrogen_oxide_rank_lbs = NOx Emissions Rate per MWh (U.S. Rank) (rank); prime_source; sulfer_dioxide = SO2 Emissions (short tons); sulfer_dioxide_lbs = SO2 Emissions Rate per MWh (pounds per megawatthour); sulfer_dioxide_rank = SO2 Emissions (U.S. Rank) (rank); sulfer_dioxide_rank_lbs = SO2 Emissions Rate per MWh (U.S. Rank) (rank); total_retail_sales = Retail Sales of Electricity, Total Electric Industry (megawatthours); total_retail_sales_rank = Retail Sales of Electricity, Total Electric Industry (U.S. Rank) (rank). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_retail_price", + "average_retail_price_rank", + "capacity_elec_utilities", + "capacity_elect_utilities_rank", + "capacity_ipp", + "capacity_ipp_rank", + "carbon_dioxide", + "carbon_dioxide_lbs", + "carbon_dioxide_rank", + "carbon_dioxide_rank_lbs", + "direct_use", + "direct_use_rank", + "eop_sales", + "eop_sales_rank", + "fsp_sales_rank", + "fsp_service_provider_sales", + "generation_elect_utils", + "generation_elect_utils_rank", + "generation_ipp", + "generation_ipp_rank", + "net_generation", + "net_generation_rank", + "net_summer_capacity", + "net_summer_capacity_rank", + "nitrogen_oxide", + "nitrogen_oxide_lbs", + "nitrogen_oxide_rank", + "nitrogen_oxide_rank_lbs", + "prime_source", + "sulfer_dioxide", + "sulfer_dioxide_lbs", + "sulfer_dioxide_rank", + "sulfer_dioxide_rank_lbs", + "total_retail_sales", + "total_retail_sales_rank" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesStateRankingsForKeyStatistics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_retail_price", + "type": "float | None", + "description": "Average Retail Price of Electricity (cents per kilowatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_retail_price_rank", + "type": "float | None", + "description": "Average Retail Price of Electricity (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity_elec_utilities", + "type": "float | None", + "description": "Net Summer Capacity, Electric Power Sector (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity_elect_utilities_rank", + "type": "float | None", + "description": "Average Retail Price of Electricity (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity_ipp", + "type": "float | None", + "description": "Net Summer Capacity, Independent Power Producers and Industrial / Commercial Sectors (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity_ipp_rank", + "type": "float | None", + "description": "Net Summer Capacity, Independent Power Producers and Industrial / Commercial Sectors (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "carbon_dioxide", + "type": "float | None", + "description": "CO2 Emissions (thousand metric tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "carbon_dioxide_lbs", + "type": "float | None", + "description": "CO2 Emissions Rate per MWh (pounds per megawatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "carbon_dioxide_rank", + "type": "float | None", + "description": "CO2 Emissions (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "carbon_dioxide_rank_lbs", + "type": "float | None", + "description": "CO2 Emissions Rate per MWh (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_use", + "type": "float | None", + "description": "Direct Use of Generation by Commercial and Industrial Facilities (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_use_rank", + "type": "float | None", + "description": "Direct Use of Generation by Commercial and Industrial Facilities (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eop_sales", + "type": "float | None", + "description": "Retail Sales of Electrcity by Energy-Only Providers (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eop_sales_rank", + "type": "float | None", + "description": "Retail Sales of Electrcity by Energy-Only Providers (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fsp_sales_rank", + "type": "float | None", + "description": "Retail Sales of Electrcity by Full Service Providers and Electricity Sold Directly by Commercial and Industrial Facilities (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fsp_service_provider_sales", + "type": "float | None", + "description": "Retail Sales of Electrcity by Full Service Providers and Electricity Sold Directly by Commercial and Industrial Facilities (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generation_elect_utils", + "type": "float | None", + "description": "Net Generation, Electric Power Sector (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generation_elect_utils_rank", + "type": "float | None", + "description": "Net Generation, Electric Power Sector (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generation_ipp", + "type": "float | None", + "description": "Net Generation, Independent Power Producers and Industrial / Commercial Sectors (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generation_ipp_rank", + "type": "float | None", + "description": "Net Generation, Independent Power Producers and Industrial / Commercial Sectors (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_generation", + "type": "float | None", + "description": "Net Generation, All Sectors (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_generation_rank", + "type": "float | None", + "description": "Net Generation, All Sectors (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_summer_capacity", + "type": "float | None", + "description": "Net Summer Capacity, All Sectors (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_summer_capacity_rank", + "type": "float | None", + "description": "Net Summer Capacity, All Sectors (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nitrogen_oxide", + "type": "float | None", + "description": "NOx Emissions (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nitrogen_oxide_lbs", + "type": "float | None", + "description": "NOx Emissions Rate per MWh (pounds per megawatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nitrogen_oxide_rank", + "type": "float | None", + "description": "NOx Emissions (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nitrogen_oxide_rank_lbs", + "type": "float | None", + "description": "NOx Emissions Rate per MWh (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prime_source", + "type": "str | None", + "description": "Prime Source", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfer_dioxide", + "type": "float | None", + "description": "SO2 Emissions (short tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfer_dioxide_lbs", + "type": "float | None", + "description": "SO2 Emissions Rate per MWh (pounds per megawatthour). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfer_dioxide_rank", + "type": "float | None", + "description": "SO2 Emissions (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sulfer_dioxide_rank_lbs", + "type": "float | None", + "description": "SO2 Emissions Rate per MWh (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_retail_sales", + "type": "float | None", + "description": "Retail Sales of Electricity, Total Electric Industry (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_retail_sales_rank", + "type": "float | None", + "description": "Retail Sales of Electricity, Total Electric Industry (U.S. Rank) (rank). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesStateRankingsForKeyStatistics", + "openapi_extra": { + "widget_config": { + "name": "State Rankings for Key Statistics", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesStateRankingsForKeyStatistics" + } + }, + "/eia/state_electricity_profiles/supply_and_disposition_of_electricity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Supply and disposition of electricity. Supply and disposition of electricity by state. Sources: Forms EIA-860, EIA-861, and EIA-923 Product: State Electricity Profiles, Table 10", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.state_electricity_profiles.supply_and_disposition_of_electricity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: combined_heat_and_pwr_comm = Net Generation from Commercial Sector (megawatthours); combined_heat_and_pwr_elect = Net Generation from Independent Power Producers, Combined Heat and Power (megawatthours); combined_heat_and_pwr_indust = Net Generation from Industrial Sector (megawatthours); direct_use = Direct Use of Generation by Commercial and Industrial Facilities (megawatthours); elect_pwr_sector_gen_subtotal = Net Generation from Electric Power Sector (megawatthours); electric_utilities = Net Generation from Electric Utilities (megawatthours); energy_only_providers = Retail Sales of Electrcity by Energy-Only Providers (megawatthours); estimated_losses = Estimated Losses Incurred in Transmission and Distribution (megawatthours); facility_direct = Retail Sales of Electricity Sold Directly by Commercial and Industrial Facilities (megawatthours); full_service_providers = Retail Sales of Electricity by Full Service Providers (megawatthours); independent_power_producers = Net Generation from Independent Power Producers, Non-Combined Heat and Power (megawatthours); indust_and_comm_gen_subtotal = Net Generation from Industrial and Commercial Sectors (megawatthours); net_interstate_trade = Net Interstate Imports (megawatthours); net_trade_index = Net Trade Index Ratio (ratio); total_disposition (megawatthours); total_elect_indust = Retail Sales of Electricity, Total Electric Industry (megawatthours); total_international_exports (megawatthours); total_international_imports (megawatthours); total_net_generation = Net Generation from All Sectors (megawatthours); total_supply (megawatthours); unaccounted = Unaccounted Electricity (megawatthours). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "combined_heat_and_pwr_comm", + "combined_heat_and_pwr_elect", + "combined_heat_and_pwr_indust", + "direct_use", + "elect_pwr_sector_gen_subtotal", + "electric_utilities", + "energy_only_providers", + "estimated_losses", + "facility_direct", + "full_service_providers", + "independent_power_producers", + "indust_and_comm_gen_subtotal", + "net_interstate_trade", + "net_trade_index", + "total_disposition", + "total_elect_indust", + "total_international_exports", + "total_international_imports", + "total_net_generation", + "total_supply", + "unaccounted" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaStateElectricityProfilesSupplyAndDispositionOfElectricity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "combined_heat_and_pwr_comm", + "type": "float | None", + "description": "Net Generation from Commercial Sector (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "combined_heat_and_pwr_elect", + "type": "float | None", + "description": "Net Generation from Independent Power Producers, Combined Heat and Power (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "combined_heat_and_pwr_indust", + "type": "float | None", + "description": "Net Generation from Industrial Sector (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_use", + "type": "float | None", + "description": "Direct Use of Generation by Commercial and Industrial Facilities (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "elect_pwr_sector_gen_subtotal", + "type": "float | None", + "description": "Net Generation from Electric Power Sector (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "electric_utilities", + "type": "float | None", + "description": "Net Generation from Electric Utilities (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "energy_only_providers", + "type": "float | None", + "description": "Retail Sales of Electrcity by Energy-Only Providers (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "estimated_losses", + "type": "float | None", + "description": "Estimated Losses Incurred in Transmission and Distribution (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "facility_direct", + "type": "float | None", + "description": "Retail Sales of Electricity Sold Directly by Commercial and Industrial Facilities (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "full_service_providers", + "type": "float | None", + "description": "Retail Sales of Electricity by Full Service Providers (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "independent_power_producers", + "type": "float | None", + "description": "Net Generation from Independent Power Producers, Non-Combined Heat and Power (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indust_and_comm_gen_subtotal", + "type": "float | None", + "description": "Net Generation from Industrial and Commercial Sectors (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_interstate_trade", + "type": "float | None", + "description": "Net Interstate Imports (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_trade_index", + "type": "float | None", + "description": "Net Trade Index Ratio (ratio). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_disposition", + "type": "float | None", + "description": "Total Disposition (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_elect_indust", + "type": "float | None", + "description": "Retail Sales of Electricity, Total Electric Industry (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_international_exports", + "type": "float | None", + "description": "Total International Exports (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_international_imports", + "type": "float | None", + "description": "Total International Imports (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_net_generation", + "type": "float | None", + "description": "Net Generation from All Sectors (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_supply", + "type": "float | None", + "description": "Total Supply (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unaccounted", + "type": "float | None", + "description": "Unaccounted Electricity (megawatthours). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaStateElectricityProfilesSupplyAndDispositionOfElectricity", + "openapi_extra": { + "widget_config": { + "name": "Supply and disposition of electricity", + "category": "EIA", + "subCategory": "State Specific Data", + "source": [ + "EIA" + ] + }, + "model": "EiaStateElectricityProfilesSupplyAndDispositionOfElectricity" + } + }, + "/eia/densified_biomass/capacity_by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Capacity by Region. Densified biomass capacity includes number of facilities and number of employees. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.capacity_by_region(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: capacity (tons); number_of_facilities (number of facilities); number_of_fte_employees (number of fte employees). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "capacity", + "number_of_facilities", + "number_of_fte_employees" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "south", + "us_total", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassCapacityByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity", + "type": "float | None", + "description": "Capacity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_facilities", + "type": "float | None", + "description": "Number of facilities (number of facilities). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_fte_employees", + "type": "float | None", + "description": "Number of fte employees (number of fte employees). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassCapacityByRegion", + "openapi_extra": { + "widget_config": { + "name": "Capacity by Region", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassCapacityByRegion" + } + }, + "/eia/densified_biomass/characteristics_by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Characteristics by Region. Densified biomass characteristics includes fuel type, average ash, heat, and moisture content by region. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.characteristics_by_region(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_ash (percent by weight); average_heat (btu/lb); average_moisture (percent by weight). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_ash", + "average_heat", + "average_moisture" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type", + "type": "str | None | list[str | None]", + "description": "Fuel Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_bricks_log", + "wood_pellets_premium_standard", + "wood_pellets_utility" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "south", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassCharacteristicsByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None", + "description": "Fuel Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type_name", + "type": "str | None", + "description": "Fuel Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_ash", + "type": "float | None", + "description": "Average ash (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_heat", + "type": "float | None", + "description": "Average heat (btu/lb). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_moisture", + "type": "float | None", + "description": "Average moisture (percent by weight). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassCharacteristicsByRegion", + "openapi_extra": { + "widget_config": { + "name": "Characteristics by Region", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassCharacteristicsByRegion" + } + }, + "/eia/densified_biomass/export_sales_and_price": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Export Sales and Price. Densified biomass export prices and quantity. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.export_sales_and_price(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_price (USD per ton); quantity (tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_price", + "quantity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassExportSalesAndPrice", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "average_price", + "type": "float | None", + "description": "Average price (USD per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassExportSalesAndPrice", + "openapi_extra": { + "widget_config": { + "name": "Export Sales and Price", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassExportSalesAndPrice" + } + }, + "/eia/densified_biomass/feedstocks_and_costs": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Feedstocks and Costs. Densified biomass feedstocks and cost by type. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.feedstocks_and_costs(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: cost (USD per ton); quantity (tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "cost", + "quantity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type", + "type": "str | None | list[str | None]", + "description": "Fuel Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "other_residuals", + "roundwood_pulpwood", + "sawmill_residuals", + "wood_product_manufacturing_residuals" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassFeedstocksAndCosts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None", + "description": "Fuel Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type_name", + "type": "str | None", + "description": "Fuel Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cost", + "type": "float | None", + "description": "Cost (USD per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassFeedstocksAndCosts", + "openapi_extra": { + "widget_config": { + "name": "Feedstocks and Costs", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassFeedstocksAndCosts" + } + }, + "/eia/densified_biomass/inventories_by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Inventories by Region. Densified biomass inventories by region and fuel type. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.inventories_by_region(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None | list[str | None]", + "description": "Fuel Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_bricks_log", + "wood_pellets_premium_standard", + "wood_pellets_utility" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "south", + "us_total", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassInventoriesByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None", + "description": "Fuel Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type_name", + "type": "str | None", + "description": "Fuel Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inventory", + "type": "float | None", + "description": "Inventory. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassInventoriesByRegion", + "openapi_extra": { + "widget_config": { + "name": "Inventories by Region", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassInventoriesByRegion" + } + }, + "/eia/densified_biomass/production_by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Production by Region. Densified biomass production by region and fuel type. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.production_by_region(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None | list[str | None]", + "description": "Fuel Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "compressed_bricks_log", + "wood_pellets_premium_standard", + "wood_pellets_utility" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "south", + "us_total", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassProductionByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "fuel_type", + "type": "str | None", + "description": "Fuel Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_type_name", + "type": "str | None", + "description": "Fuel Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "production", + "type": "float | None", + "description": "Production (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassProductionByRegion", + "openapi_extra": { + "widget_config": { + "name": "Production by Region", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassProductionByRegion" + } + }, + "/eia/densified_biomass/sales_and_price_by_region": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sales and Price by Region. Densified biomass sales and average price by region. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.sales_and_price_by_region(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: average_price (USD per ton); quantity (tons). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "average_price", + "quantity" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "south", + "us_total", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassSalesAndPriceByRegion", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_price", + "type": "float | None", + "description": "Average price (USD per ton). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (tons). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassSalesAndPriceByRegion", + "openapi_extra": { + "widget_config": { + "name": "Sales and Price by Region", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassSalesAndPriceByRegion" + } + }, + "/eia/densified_biomass/wood_pellet_plant_capacity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Wood Pellet Plant Capacity. Details on wood pellet plants includes region, respondent, capacity, and status. Source: EIA-63C Report: www.eia.gov/biomass/", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.densified_biomass.wood_pellet_plant_capacity(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east", + "south", + "west" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "respondent", + "type": "str | None | list[str | None]", + "description": "Respondent filter. Accepts a comma-separated list of values. There are 161 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "florida", + "georgia", + "idaho", + "illinois", + "indiana", + "iowa", + "kentucky", + "louisiana", + "maine", + "michigan", + "mississippi", + "missouri", + "new_hampshire", + "new_mexico", + "new_york", + "north_carolina", + "ohio", + "oregon", + "pennsylvania", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None | list[str | None]", + "description": "Operational Status filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "currently_operating", + "none", + "temporarily_not_in_operation", + "under_construction_planned", + "currently_operating_currently_operating" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDensifiedBiomassWoodPelletPlantCapacity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "respondent", + "type": "str | None", + "description": "Respondent code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "respondent_name", + "type": "str | None", + "description": "Respondent name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "Operational Status code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status_name", + "type": "str | None", + "description": "Operational Status name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity", + "type": "float | None", + "description": "Capacity (tons per year). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDensifiedBiomassWoodPelletPlantCapacity", + "openapi_extra": { + "widget_config": { + "name": "Wood Pellet Plant Capacity", + "category": "EIA", + "subCategory": "Densified Biomass", + "source": [ + "EIA" + ] + }, + "model": "EiaDensifiedBiomassWoodPelletPlantCapacity" + } + }, + "/eia/nuclear_outages/facility_level_nuclear_outages": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Facility Level Nuclear Outages. Facility level nuclear outages with capacity, outages, and percent outage. Source: Nuclear Regulatory Commission's Power Reactor Status Report. Interactive data report: Daily Status of Nuclear Reactors.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.nuclear_outages.facility_level_nuclear_outages(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: capacity (megawatts); outage (megawatts); percent_outage (percent). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "capacity", + "outage", + "percent_outage" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "facility", + "type": "str | None | list[str | None]", + "description": "Plant code filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arkansas_nuclear_one", + "beaver_valley", + "braidwood_generation_station", + "browns_ferry", + "brunswick", + "byron_generating_station", + "callaway", + "calvert_cliffs_nuclear_power_plant", + "catawba", + "clinton_power_station", + "columbia_generating_station", + "comanche_peak", + "cooper", + "crystal_river", + "davis_besse", + "diablo_canyon", + "donald_c_cook", + "dresden_generating_station", + "duane_arnold", + "edwin_i_hatch", + "fermi", + "fort_calhoun", + "grand_gulf", + "h_b_robinson", + "harris", + "indian_point_2", + "indian_point_3", + "james_a_fitzpatrick", + "joseph_m_farley", + "kewaunee", + "lasalle_generating_station", + "limerick", + "mcguire", + "millstone", + "monticello", + "nine_mile_point_nuclear_station", + "north_anna", + "oconee", + "oyster_creek", + "ppl_susquehanna", + "pseg_hope_creek_generating_station", + "pseg_salem_generating_station", + "palisades", + "palo_verde", + "peach_bottom", + "perry", + "pilgrim_nuclear_power_station", + "point_beach", + "prairie_island", + "quad_cities_generating_station", + "r_e_ginna_nuclear_power_plant", + "river_bend_station", + "san_onofre", + "seabrook", + "sequoyah", + "south_texas_project", + "st_lucie", + "surry", + "three_mile_island", + "turkey_point", + "v_c_summer", + "vermont_yankee", + "vogtle", + "waterford_3", + "watts_bar_nuclear_plant", + "wolf_creek_generating_station" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNuclearOutagesFacilityLevelNuclearOutages", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "facility", + "type": "str | None", + "description": "Plant code code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "facility_name", + "type": "str | None", + "description": "Plant code name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity", + "type": "float | None", + "description": "Capacity (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "outage", + "type": "float | None", + "description": "Outage (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_outage", + "type": "float | None", + "description": "Percent outage (percent). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNuclearOutagesFacilityLevelNuclearOutages", + "openapi_extra": { + "widget_config": { + "name": "Facility Level Nuclear Outages", + "category": "EIA", + "subCategory": "Nuclear Outages", + "source": [ + "EIA" + ] + }, + "model": "EiaNuclearOutagesFacilityLevelNuclearOutages" + } + }, + "/eia/nuclear_outages/generator_level_nuclear_outages": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Generator Level Nuclear Outages. Generator level nuclear outages with capacity, outages, and percent outage. Source: Nuclear Regulatory Commission's Power Reactor Status Report. Interactive data report: Daily Status of Nuclear Reactors.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.nuclear_outages.generator_level_nuclear_outages(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: capacity (megawatts); outage (megawatts); percent_outage (percent). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "capacity", + "outage", + "percent_outage" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "facility", + "type": "str | None | list[str | None]", + "description": "Plant code filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "arkansas_nuclear_one", + "beaver_valley", + "braidwood_generation_station", + "browns_ferry", + "brunswick", + "byron_generating_station", + "callaway", + "calvert_cliffs_nuclear_power_plant", + "catawba", + "clinton_power_station", + "columbia_generating_station", + "comanche_peak", + "cooper", + "crystal_river", + "davis_besse", + "diablo_canyon", + "donald_c_cook", + "dresden_generating_station", + "duane_arnold", + "edwin_i_hatch", + "fermi", + "fort_calhoun", + "grand_gulf", + "h_b_robinson", + "harris", + "indian_point_2", + "indian_point_3", + "james_a_fitzpatrick", + "joseph_m_farley", + "kewaunee", + "lasalle_generating_station", + "limerick", + "mcguire", + "millstone", + "monticello", + "nine_mile_point_nuclear_station", + "north_anna", + "oconee", + "oyster_creek", + "ppl_susquehanna", + "pseg_hope_creek_generating_station", + "pseg_salem_generating_station", + "palisades", + "palo_verde", + "peach_bottom", + "perry", + "pilgrim_nuclear_power_station", + "point_beach", + "prairie_island", + "quad_cities_generating_station", + "r_e_ginna_nuclear_power_plant", + "river_bend_station", + "san_onofre", + "seabrook", + "sequoyah", + "south_texas_project", + "st_lucie", + "surry", + "three_mile_island", + "turkey_point", + "v_c_summer", + "vermont_yankee", + "vogtle", + "waterford_3", + "watts_bar_nuclear_plant", + "wolf_creek_generating_station" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "generator", + "type": "str | None | list[str | None]", + "description": "Facility's generator ID number filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "1", + "2", + "3", + "4" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNuclearOutagesGeneratorLevelNuclearOutages", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "facility", + "type": "str | None", + "description": "Plant code code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "facility_name", + "type": "str | None", + "description": "Plant code name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generator", + "type": "str | None", + "description": "Facility's generator ID number code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "generator_name", + "type": "str | None", + "description": "Facility's generator ID number name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capacity", + "type": "float | None", + "description": "Capacity (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "outage", + "type": "float | None", + "description": "Outage (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_outage", + "type": "float | None", + "description": "Percent outage (percent). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNuclearOutagesGeneratorLevelNuclearOutages", + "openapi_extra": { + "widget_config": { + "name": "Generator Level Nuclear Outages", + "category": "EIA", + "subCategory": "Nuclear Outages", + "source": [ + "EIA" + ] + }, + "model": "EiaNuclearOutagesGeneratorLevelNuclearOutages" + } + }, + "/eia/nuclear_outages/us_nuclear_outages": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Nuclear Outages. Nuclear outages daily with capacity, outages, and percent outage. Source: Nuclear Regulatory Commission's Power Reactor Status Report. Interactive data report: Daily Status of Nuclear Reactors.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.nuclear_outages.us_nuclear_outages(provider='eia', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "data_type", + "type": "str | None | list[str | None]", + "description": "Data column(s) to return, comma-separated. The default returns every column. Choices: capacity (megawatts); outage (megawatts); percent_outage (percent). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "capacity", + "outage", + "percent_outage" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaNuclearOutagesUsNuclearOutages", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "capacity", + "type": "float | None", + "description": "Capacity (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "outage", + "type": "float | None", + "description": "Outage (megawatts). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_outage", + "type": "float | None", + "description": "Percent outage (percent). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaNuclearOutagesUsNuclearOutages", + "openapi_extra": { + "widget_config": { + "name": "U.S. Nuclear Outages", + "category": "EIA", + "subCategory": "Nuclear Outages", + "source": [ + "EIA" + ] + }, + "model": "EiaNuclearOutagesUsNuclearOutages" + } + }, + "/eia/crude_oil_imports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US crude oil imports by origin, destination, and grade.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Monthly crude oil imports from Canada, by grade.\nobb.eia.crude_oil_imports(provider='eia', origin='canada', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "destination", + "type": "str | None | list[str | None]", + "description": "Destination Id filter. Accepts a comma-separated list of values. There are 513 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "destination_type", + "type": "str | None | list[str | None]", + "description": "Destination Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "port", + "port_padd", + "port_state", + "refinery", + "refinery_padd", + "refinery_state", + "united_states" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "grade", + "type": "str | None | list[str | None]", + "description": "Grade Id filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "heavy_sour", + "heavy_sweet", + "light_sour", + "light_sweet", + "medium" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "origin", + "type": "str | None | list[str | None]", + "description": "Origin Id filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "africa", + "albania", + "algeria", + "angola", + "argentina", + "asia_pacific", + "australia", + "azerbaijan", + "barbados", + "belize", + "bolivia", + "brazil", + "brunei", + "cameroon", + "canada", + "canada_region", + "chad", + "china", + "colombia", + "congo_brazzaville", + "congo_kinshasa", + "cote_d_ivoire", + "denmark", + "ecuador", + "egypt", + "equatorial_guinea", + "eurasia", + "europe", + "gabon", + "ghana", + "guatemala", + "guyana", + "indonesia", + "iran", + "iraq", + "italy", + "kazakhstan", + "kuwait", + "libya", + "malaysia", + "mauritania", + "mexico", + "middle_east", + "netherlands", + "nigeria", + "non_opec", + "norway", + "opec", + "oman", + "other_americas", + "panama", + "papua_new_guinea", + "peru", + "qatar", + "russia", + "saudi_arabia", + "senegal", + "south_africa", + "south_sudan", + "spain", + "syria", + "thailand", + "the_bahamas", + "trinidad_and_tobago", + "tunisia", + "united_arab_emirates", + "united_kingdom", + "venezuela", + "vietnam", + "world", + "yemen" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "origin_type", + "type": "str | None | list[str | None]", + "description": "Origin Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "country", + "opec_non_opec", + "region", + "world" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaCrudeOilImports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "destination", + "type": "str | None", + "description": "Destination Id code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "destination_name", + "type": "str | None", + "description": "Destination Id name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "destination_type", + "type": "str | None", + "description": "Destination Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "destination_type_name", + "type": "str | None", + "description": "Destination Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "grade", + "type": "str | None", + "description": "Grade Id code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "grade_name", + "type": "str | None", + "description": "Grade Id name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "origin", + "type": "str | None", + "description": "Origin Id code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "origin_name", + "type": "str | None", + "description": "Origin Id name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "origin_type", + "type": "str | None", + "description": "Origin Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "origin_type_name", + "type": "str | None", + "description": "Origin Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "float | None", + "description": "Quantity (thousand barrels). Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaCrudeOilImports", + "openapi_extra": { + "widget_config": { + "name": "Crude Oil Imports", + "category": "EIA", + "subCategory": "Petroleum", + "source": [ + "EIA" + ] + }, + "model": "EiaCrudeOilImports" + } + }, + "/eia/international": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "International energy production, consumption, and trade statistics by country and region.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Annual petroleum production for OPEC members.\nobb.eia.international(provider='eia', product='total_petroleum_and_other_liquids', activity='production', country='opec', limit=100)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "activity", + "type": "str | None | list[str | None]", + "description": "Activity filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "consumption", + "imports", + "production", + "stocks_oecd" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "Country/Region filter. Accepts a comma-separated list of values. There are 268 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "country_type", + "type": "str | None | list[str | None]", + "description": "Country/Region Type filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "country", + "region" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None | list[str | None]", + "description": "Product filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "canada_imports_by_source", + "crude_oil_including_lease_condensate", + "crude_oil_ngpl_and_other_liquids", + "france_imports_by_source", + "germany_imports_by_source", + "italy_imports_by_source", + "japan_imports_by_source", + "ngpl", + "oecd_europe_imports_by_source", + "oecd_imports", + "other_liquids", + "petroleum_and_other_liquids", + "refined_petroleum_products", + "refinery_processing_gain", + "south_korea_imports_by_source", + "total_petroleum_and_other_liquids", + "us_imports_by_source", + "united_kingdom_imports_by_source" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None | list[str | None]", + "description": "Unit filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "1000_metric_tons", + "millions_barrels", + "thousand_barrels_per_day" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaInternational", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "activity", + "type": "str | None", + "description": "Activity code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "activity_name", + "type": "str | None", + "description": "Activity name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country/Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_name", + "type": "str | None", + "description": "Country/Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_type", + "type": "str | None", + "description": "Country/Region Type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_type_name", + "type": "str | None", + "description": "Country/Region Type name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_flag", + "type": "str | None", + "description": "Data flag ID code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_flag_name", + "type": "str | None", + "description": "Data flag ID name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product", + "type": "str | None", + "description": "Product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_name", + "type": "str | None", + "description": "Product name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit_name", + "type": "str | None", + "description": "Unit name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaInternational", + "openapi_extra": { + "widget_config": { + "name": "International Energy Data", + "category": "EIA", + "subCategory": "International", + "source": [ + "EIA" + ] + }, + "model": "EiaInternational" + } + }, + "/eia/seds": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "State Energy Data System (SEDS): annual state-level energy estimates back to 1960.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Total energy consumption per capita for Texas.\nobb.eia.seds(provider='eia', series='total_energy_consumption_per_capita', state='texas')\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Unique series identifier filter. Accepts a comma-separated list of values. There are 968 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State name filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "alabama", + "alaska", + "arizona", + "arkansas", + "california", + "colorado", + "connecticut", + "delaware", + "district_of_columbia", + "federal_offshore_gulf_of_america", + "federal_offshore_pacific", + "florida", + "georgia", + "hawaii", + "idaho", + "illinois", + "indiana", + "iowa", + "kansas", + "kentucky", + "louisiana", + "maine", + "maryland", + "massachusetts", + "michigan", + "minnesota", + "mississippi", + "missouri", + "montana", + "nebraska", + "nevada", + "new_hampshire", + "new_jersey", + "new_mexico", + "new_york", + "north_carolina", + "north_dakota", + "ohio", + "oklahoma", + "oregon", + "pennsylvania", + "rhode_island", + "south_carolina", + "south_dakota", + "tennessee", + "texas", + "united_states", + "utah", + "vermont", + "virginia", + "washington", + "west_virginia", + "wisconsin", + "wyoming" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaSeds", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "series", + "type": "str | None", + "description": "Unique series identifier code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Unique series identifier name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "State name code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "State name name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaSeds", + "openapi_extra": { + "widget_config": { + "name": "State Energy Data System (SEDS)", + "category": "EIA", + "subCategory": "State Energy Data System", + "source": [ + "EIA" + ] + }, + "model": "EiaSeds" + } + }, + "/eia/total_energy": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly Energy Review series covering all energy sources, by MSN mnemonic.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Monthly total US electricity net generation.\nobb.eia.total_energy(provider='eia', msn='ELETPUS')\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency. The default is 'monthly'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "msn", + "type": "str | None | list[str | None]", + "description": "Unique series identifier filter. Accepts a comma-separated list of values. There are 984 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaTotalEnergy", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "msn", + "type": "str | None", + "description": "Unique series identifier code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "msn_name", + "type": "str | None", + "description": "Unique series identifier name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaTotalEnergy", + "openapi_extra": { + "widget_config": { + "name": "Total Energy (Monthly Energy Review)", + "category": "EIA", + "subCategory": "Total Energy", + "source": [ + "EIA" + ] + }, + "model": "EiaTotalEnergy" + } + }, + "/eia/aeo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Annual Energy Outlook: long-term US energy projections by release and scenario.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Reference-case projections from the 2025 Annual Energy Outlook.\nobb.eia.aeo(provider='eia', release='2025', scenario='reference_case', table='total_energy_supply_disposition_and_price_summary', region='united_states')\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "release", + "type": "str | None", + "description": "The Annual Energy Outlook release. Facet values vary by release; use the `facet_options` endpoint to list them.", + "default": "2026", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "history", + "type": "str | None | list[str | None]", + "description": "History filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "historic", + "projection" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "east_north_central", + "east_south_central", + "florida_reliability_coordinating_council", + "midcontinent_central", + "midcontinent_east", + "midcontinent_south", + "midcontinent_west", + "middle_atlantic", + "midwest_reliability_council_east", + "midwest_reliability_council_west", + "mountain", + "new_england", + "no_regional_tables", + "northeast_power_coordinating_council_long_island", + "northeast_power_coordinating_council_nyc_westchester", + "northeast_power_coordinating_council_new_england", + "northeast_power_coordinating_council_new_york_city_and_long", + "northeast_power_coordinating_council_northeast", + "northeast_power_coordinating_council_upstate_new_york", + "pjm_commonwealth_edison", + "pjm_dominion", + "pjm_east", + "pjm_west", + "pacific", + "reliability_first_corporation_east", + "reliability_first_corporation_michigan", + "reliability_first_corporation_west", + "serc_reliability_corporation_central", + "serc_reliability_corporation_delta", + "serc_reliability_corporation_east", + "serc_reliability_corporation_gateway", + "serc_reliability_corporation_southeastern", + "serc_reliability_corporation_virginia_carolina", + "south_atlantic", + "southwest_power_pool_central", + "southwest_power_pool_north", + "southwest_power_pool_south", + "texas_regional_entity", + "texas_reliability_entity", + "united_states", + "west_north_central", + "west_south_central", + "western_electricity_coordinating_council_basin", + "western_electricity_coordinating_council_california", + "western_electricity_coordinating_council_california_north", + "western_electricity_coordinating_council_california_south", + "western_electricity_coordinating_council_northwest_power", + "western_electricity_coordinating_council_rockies", + "western_electricity_coordinating_council_southwest" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "scenario", + "type": "str | None | list[str | None]", + "description": "Scenario filter. Accepts a comma-separated list of values. There are 149 valid values - use the `facet_options` endpoint to list them. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None | list[str | None]", + "description": "Table filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "air_travel_energy_use", + "aircraft_stock", + "aluminum_industry_energy_consumption", + "bulk_chemical_industry_energy_consumption", + "cement_and_lime_industry_energy_consumption", + "coal_minemouth_prices_by_region_and_type", + "coal_production_and_minemouth_prices_by_region", + "coal_production_by_region_and_type", + "coal_supply_disposition_and_prices", + "commercial_sector_energy_consumption_floorspace_and", + "commercial_sector_key_indicators_and_consumption", + "components_of_selected_petroleum_product_prices", + "conversion_factors", + "electric_power_projections_by_electricity_market_module", + "electricity_generating_capacity", + "electricity_generation_capacity_by_electricity_market", + "electricity_generation_by_electricity_market_module_region", + "electricity_supply_disposition_prices_and_emissions", + "electricity_trade", + "employment_and_shipments_by_industry_and_income_and", + "energy_consumption_by_sector_and_source", + "energy_prices_by_sector_and_source", + "energy_related_carbon_dioxide_emissions_by_end_use", + "energy_related_carbon_dioxide_emissions_by_sector_and_source", + "food_industry_energy_consumption", + "freight_transportation_energy_use", + "glass_industry_energy_consumption", + "imported_liquids_by_source", + "industrial_sector_key_indicators_and_consumption", + "industrial_sector_macroeconomic_indicators", + "international_petroleum_and_other_liquids_supply", + "iron_and_steel_industry_energy_consumption", + "light_duty_vehicle_energy_consumption_by_technology_type", + "light_duty_vehicle_miles_traveled_by_technology_type", + "light_duty_vehicle_miles_per_gallon_by_technology_type", + "light_duty_vehicle_sales_by_technology_type", + "light_duty_vehicle_stock_by_technology_type", + "lower_48_crude_oil_production_and_wellhead_prices_by_supply", + "lower_48_natural_gas_production_and_supply_prices_by_supply", + "macroeconomic_indicators", + "metal_based_durables_industry_energy_consumption", + "natural_gas_consumption_by_end_use_sector_and_census", + "natural_gas_delivered_prices_by_end_use_sector_and_census", + "natural_gas_imports_and_exports", + "natural_gas_supply_disposition_and_prices", + "new_light_duty_vehicle_fuel_economy", + "new_light_duty_vehicle_prices", + "new_light_duty_vehicle_range", + "nonmanufacturing_sector_energy_consumption", + "oil_and_gas_end_of_year_reserves_and_annual_reserve", + "oil_and_gas_supply", + "other_manufacturing_industry_energy_consumption", + "paper_industry_energy_consumption", + "petroleum_and_other_liquids_prices", + "petroleum_and_other_liquids_supply_and_disposition", + "primary_natural_gas_flows_entering_ngtdm_region_from", + "refining_industry_energy_consumption", + "renewable_energy_consumption_by_sector_and_source", + "renewable_energy_generating_capacity_and_generation", + "renewable_energy_generation_by_fuel", + "residential_sector_equipment_stock_and_efficiency", + "residential_sector_key_indicators_and_consumption", + "summary_of_new_light_duty_vehicle_size_class_attributes", + "hydrogen_supply_disposition_and_prices", + "overnight_capital_costs_for_new_electricity_generating", + "shale_gas_and_tight_oil_production_by_play_1", + "carbon_dioxide_emissions_by_category_and_sector", + "capacity_with_carbon_capture_and_carbon_flows", + "technology_market_penetration_in_light_duty_vehicles", + "total_energy_supply_disposition_and_price_summary", + "transportation_fleet_car_and_truck_fuel_consumption_by_type", + "transportation_fleet_car_and_truck_sales_by_type_and", + "transportation_fleet_car_and_truck_stock_by_type_and", + "transportation_fleet_car_and_truck_vehicle_miles_traveled", + "transportation_sector_energy_use_by_fuel_type_within_a_mode", + "transportation_sector_energy_use_by_mode_and_type", + "transportation_sector_key_indicators_and_delivered_energy", + "world_metallurgical_coal_flows_by_importing_regions_and", + "world_steam_coal_flows_by_importing_regions_and_exporting", + "world_total_coal_flows_by_importing_regions_and_exporting" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaAeo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "history", + "type": "str | None", + "description": "History code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "history_name", + "type": "str | None", + "description": "History name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "scenario", + "type": "str | None", + "description": "Scenario code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "scenario_name", + "type": "str | None", + "description": "Scenario name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None", + "description": "Table code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table_name", + "type": "str | None", + "description": "Table name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaAeo", + "openapi_extra": { + "widget_config": { + "name": "Annual Energy Outlook", + "category": "EIA", + "subCategory": "Annual Energy Outlook", + "source": [ + "EIA" + ] + }, + "model": "EiaAeo" + } + }, + "/eia/ieo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "International Energy Outlook: long-term world energy projections by release and scenario.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Reference-case projections from the 2023 International Energy Outlook.\nobb.eia.ieo(provider='eia', release='2023', table='3', limit=500)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "release", + "type": "str | None", + "description": "The International Energy Outlook release. Facet values vary by release; use the `facet_options` endpoint to list them.", + "default": "2023", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "history", + "type": "str | None | list[str | None]", + "description": "History filter. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "historic", + "projection" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Region filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "africa", + "africa_and_middle_east", + "americas", + "asia_pacific", + "australia_and_new_zealand", + "australia_new_zealand", + "brazil", + "canada", + "china", + "eastern_europe_and_eurasia", + "europe_and_eurasia", + "india", + "japan", + "mexico", + "mexico_and_other_oecd_americas", + "middle_east", + "no_regional_tables", + "oecd_europe", + "other_americas", + "other_asia_pacific", + "other_non_oecd_americas", + "other_non_oecd_asia", + "other_non_oecd_europe_and_eurasia", + "russia", + "south_korea", + "total_non_oecd", + "total_oecd", + "total_world", + "united_states", + "western_europe" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "scenario", + "type": "str | None | list[str | None]", + "description": "Scenario filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "high_economic_growth", + "high_oil_price", + "high_zero_carbon_technology_cost", + "low_economic_growth", + "low_oil_price", + "low_zero_carbon_technology_cost", + "reference" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series filter. Accepts a comma-separated list of values. Use the `facet_options` endpoint for the valid values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None | list[str | None]", + "description": "Table filter. Accepts a comma-separated list of values. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "aircraft_efficiency", + "buildings_delivered_energy_consumption_by_end_use_sector", + "delivered_energy_consumption_by_end_use_sector_and_fuel", + "freight_air_transport", + "industrial_energy_consumption_by_sector_for_selected_regions", + "international_other_liquid_fuels_a_production_by_region_and", + "light_duty_vehicle_stocks_by_technology", + "new_light_duty_vehicle_sales_by_technology", + "passenger_air_travel", + "passenger_aircraft_capacity", + "revenue_freight_air_transport", + "revenue_passenger_air_travel", + "total_commercial_jet_fuel_use_by_region", + "transportation_sector_energy_consumption_by_region_and_fuel", + "transportation_sector_freight_transport_energy_consumption", + "transportation_sector_passenger_transport_energy", + "world_carbon_dioxide_emissions_by_region", + "world_carbon_dioxide_emissions_from_coal_use_by_region", + "world_carbon_dioxide_emissions_from_liquids_use_by_region", + "world_carbon_dioxide_emissions_from_natural_gas_use_by", + "world_carbon_dioxide_intensity_of_energy_use_by_region", + "world_coal_consumption_by_region", + "world_coal_exports_by_region", + "world_coal_imports_by_region", + "world_coal_supply_by_region", + "world_consumption_of_hydroelectricity_and_other_renewable", + "world_crude_oil_a_production_by_region_and_country", + "world_energy_intensity_by_region", + "world_gross_domestic_product_by_region_expressed_in_market", + "world_gross_domestic_product_by_region_expressed_in", + "world_gross_domestic_product_per_capita_by_region_expressed", + "world_installed_coal_fired_generating_capacity_by_region", + "world_installed_geothermal_generating_capacity_by_region", + "world_installed_hydroelectric_and_other_renewable", + "world_installed_hydroelectric_generating_capacity_by_region", + "world_installed_liquids_fired_generating_capacity_by_region", + "world_installed_natural_gas_fired_generating_capacity_by", + "world_installed_nuclear_generating_capacity_by_region_and", + "world_installed_other_renewable_generating_capacity_by", + "world_installed_solar_generating_capacity_by_region_and", + "world_installed_wind_powered_generating_capacity_by_region", + "world_liquids_consumption_by_region", + "world_metallurgical_coal_consumptiom_by_region", + "world_metallurgical_coal_consumption_by_region", + "world_metallurgical_coal_exports_by_region", + "world_metallurgical_coal_imports_by_region", + "world_metallurgical_coal_net_trade_by_region", + "world_metallurgical_coal_supply_by_region", + "world_natural_gas_consumption_by_region", + "world_net_coal_fired_electricity_generation_by_region_and", + "world_net_geothermal_electricity_generation_by_region_and", + "world_net_hydroelectric_and_other_renewable_electricity", + "world_net_hydroelectric_electricity_generation_by_region", + "world_net_liquids_fired_electricity_generation_by_region", + "world_net_natural_gas_fired_electricity_generation_by", + "world_net_nuclear_electricity_generation_by_region_and", + "world_net_other_renewable_electricity_generation_by_region", + "world_net_solar_electricity_generation_by_region_and_country", + "world_net_trade_in_natural_gas_by_region", + "world_net_wind_powered_electricity_generation_by_region_and", + "world_nuclear_energy_consumption_by_region", + "world_other_natural_gas_production_by_region", + "world_petroleum_and_other_liquids_production_by_region_and", + "world_population_by_region", + "world_thermal_coal_consumptiom_by_region", + "world_thermal_coal_exports_by_region", + "world_thermal_coal_imports_by_region", + "world_thermal_coal_net_trade_by_region", + "world_thermal_coal_supply_by_region", + "world_tight_gas_shale_gas_and_coalbed_methane_production_by", + "world_total_coal_consumptiom_by_region", + "world_total_coal_exports_by_region", + "world_total_coal_imports_by_region", + "world_total_coal_net_trade_by_region", + "world_total_coal_supply_by_region", + "world_total_energy_consumption_by_region_and_fuel", + "world_total_installed_generating_capacity_by_region_and", + "world_total_natural_gas_production_by_region", + "world_total_net_electricity_generation_by_region_and_country", + "world_total_primary_energy_consumption_by_region" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaIeo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "history", + "type": "str | None", + "description": "History code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "history_name", + "type": "str | None", + "description": "History name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "Region code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_name", + "type": "str | None", + "description": "Region name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "scenario", + "type": "str | None", + "description": "Scenario code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "scenario_name", + "type": "str | None", + "description": "Scenario name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Series name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None", + "description": "Table code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "table_name", + "type": "str | None", + "description": "Table name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Value. Withheld or unavailable values return as null.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaIeo", + "openapi_extra": { + "widget_config": { + "name": "International Energy Outlook", + "category": "EIA", + "subCategory": "International Energy Outlook", + "source": [ + "EIA" + ] + }, + "model": "EiaIeo" + } + }, + "/eia/data_browser": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Query any EIA APIv2 data route directly by path, with facet filters and pagination.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Query any APIv2 route directly - Brent spot price, monthly.\nobb.eia.data_browser(provider='eia', route='petroleum/pri/spt', frequency='monthly', facets='product:EPCBRENT', limit=12)\n```\n\n", + "parameters": { + "standard": [], + "eia": [ + { + "name": "route", + "type": "str", + "description": "The API route to query, e.g. 'petroleum/pri/spt' or 'electricity/rto/region-data'.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The data frequency id, e.g. 'monthly'. The default is the route's native frequency.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "data_type", + "type": "str | None", + "description": "Data column id(s) to return, comma-separated, e.g. 'value' or 'quantity,price'. The default returns every column available for the route.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "facets", + "type": "str | None", + "description": "Facet filters as 'facetId:value' pairs separated by semicolons, with multiple values comma-separated, e.g. 'duoarea:NUS;product:EPD2D,EPD2DXL0'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort", + "type": "str | None", + "description": "Sort the results by date.", + "default": "asc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of rows to return. The default returns all rows, paginating requests as needed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EiaDataBrowser", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "eia": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Start of the period the record covers. Hourly frequencies return a timestamp.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "EiaDataBrowser", + "openapi_extra": { + "widget_config": { + "name": "EIA API Data Browser", + "category": "EIA", + "subCategory": "Reference", + "source": [ + "EIA" + ] + }, + "model": "EiaDataBrowser" + } + }, + "/eia/petroleum_status_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "EIA Weekly Petroleum Status Report.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.petroleum_status_report(provider='eia')\n# Get the weekly estimates of the imports and exports of crude oil.\nobb.eia.petroleum_status_report(provider='eia', category='weekly_estimates', table='imports')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "eia": [ + { + "name": "category", + "type": "str | None", + "description": "The group of data to be returned. The default is the balance sheet.", + "default": "balance_sheet", + "optional": true, + "choices": [ + "balance_sheet", + "inputs_and_production", + "refiner_blender_net_production", + "crude_petroleum_stocks", + "gasoline_fuel_stocks", + "total_gasoline_by_sub_padd", + "distillate_fuel_oil_stocks", + "imports", + "imports_by_country", + "weekly_estimates", + "spot_prices_crude_gas_heating", + "spot_prices_diesel_jet_fuel_propane", + "retail_prices" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None | list[str | None]", + "description": "The specific table element within the category to be returned, default is 'stocks', if the category is 'weekly_estimates', else 'all'.\n Note: Choices represent all available tables from the entire collection and are not all available for every category.\n Invalid choices will raise a ValidationError with a message indicating the valid choices for the selected category.\n Choices are:\n all\n conventional_gas\n crude\n crude_production\n crude_production_avg\n diesel\n ethanol_plant_production\n ethanol_plant_production_avg\n exports\n exports_avg\n heating_oil\n imports\n imports_avg\n imports_by_country\n imports_by_country_avg\n inputs_and_utilization\n inputs_and_utilization_avg\n jet_fuel\n monthly\n net_imports_inc_spr_avg\n net_imports_incl_spr\n net_production\n net_production_avg\n net_production_by_product\n net_production_by_production_avg\n product_by_region\n product_by_region_avg\n product_supplied\n product_supplied_avg\n propane\n rbob\n refiner_blender_net_production\n refiner_blender_net_production_avg\n stocks\n supply\n supply_avg\n ulta_low_sulfur_distillate_reclassification\n ulta_low_sulfur_distillate_reclassification_avg\n weekly Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "all", + "conventional_gas", + "crude", + "crude_production", + "crude_production_avg", + "diesel", + "ethanol_plant_production", + "ethanol_plant_production_avg", + "exports", + "exports_avg", + "heating_oil", + "imports", + "imports_avg", + "imports_by_country", + "imports_by_country_avg", + "inputs_and_utilization", + "inputs_and_utilization_avg", + "jet_fuel", + "monthly", + "net_imports_inc_spr_avg", + "net_imports_incl_spr", + "net_production", + "net_production_avg", + "net_production_by_product", + "net_production_by_production_avg", + "product_by_region", + "product_by_region_avg", + "product_supplied", + "product_supplied_avg", + "propane", + "rbob", + "refiner_blender_net_production", + "refiner_blender_net_production_avg", + "stocks", + "supply", + "supply_avg", + "ulta_low_sulfur_distillate_reclassification", + "ulta_low_sulfur_distillate_reclassification_avg", + "weekly" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Subsequent requests for the same source data are cached for the session using ALRU cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "PetroleumStatusReport", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str", + "description": "Table name for the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "int | None", + "description": "Presented order of the data, relative to the table.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Title of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int", + "description": "Value of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit or scale of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "eia": [] + }, + "model": "PetroleumStatusReport", + "openapi_extra": { + "widget_config": { + "name": "Weekly Petroleum Status Report", + "category": "EIA", + "subCategory": "Petroleum", + "source": [ + "EIA" + ] + }, + "model": "PetroleumStatusReport" + } + }, + "/eia/short_term_energy_outlook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly short term (18 month) projections using EIA's STEO model.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.eia.short_term_energy_outlook(provider='eia')\n# Get the US Energy Markets Summary table.\nobb.eia.short_term_energy_outlook(provider='eia', table='01')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "eia": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. If provided, overrides the 'table' parameter to return only the specified symbol from the STEO API. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None", + "description": "The specific table within the STEO dataset. Default is '01'. When 'symbol' is provided, this parameter is ignored.\n 01: US Energy Markets Summary\n 02: Nominal Energy Prices\n 03a: World Petroleum and Other Liquid Fuels Production, Consumption, and Inventories\n 03b: Non-OPEC Petroleum and Other Liquid Fuels Production\n 03c: World Petroleum and Other Liquid Fuels Production\n 03d: World Crude Oil Production\n 03e: World Petroleum and Other Liquid Fuels Consumption\n 04a: US Petroleum and Other Liquid Fuels Supply, Consumption, and Inventories\n 04b: US Hydrocarbon Gas Liquids (HGL) and Petroleum Refinery Balances\n 04c: US Regional Motor Gasoline Prices and Inventories\n 04d: US Biofuel Supply, Consumption, and Inventories\n 05a: US Natural Gas Supply, Consumption, and Inventories\n 05b: US Regional Natural Gas Prices\n 06: US Coal Supply, Consumption, and Inventories\n 07a: US Electricity Industry Overview\n 07b: US Regional Electricity Retail Sales\n 07c: US Regional Electricity Prices\n 07d1: US Regional Electricity Generation, Electric Power Sector\n 07d2: US Regional Electricity Generation, Electric Power Sector, continued\n 07e: US Electricity Generating Capacity\n 08: US Renewable Energy Consumption\n 09a: US Macroeconomic Indicators and CO2 Emissions\n 09b: US Regional Macroeconomic Data\n 09c: US Regional Weather Data\n 10a: Drilling Productivity Metrics\n 10b: Crude Oil and Natural Gas Production from Shale and Tight Formations", + "default": "01", + "optional": true, + "choices": [ + "01", + "02", + "03a", + "03b", + "03c", + "03d", + "03e", + "04a", + "04b", + "04c", + "04d", + "05a", + "05b", + "06", + "07a", + "07b", + "07c", + "07d1", + "07d2", + "07e", + "08", + "09a", + "09b", + "09c", + "10a", + "10b" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data. Default is 'month'.", + "default": "month", + "optional": true, + "choices": [ + "month", + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ShortTermEnergyOutlook", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str | None", + "description": "Table name for the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "int | None", + "description": "Presented order of the data, relative to the table.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Title of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int", + "description": "Value of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit or scale of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "eia": [] + }, + "model": "ShortTermEnergyOutlook", + "openapi_extra": { + "widget_config": { + "name": "Short-Term Energy Outlook", + "category": "EIA", + "subCategory": "Short-Term Energy Outlook", + "source": [ + "EIA" + ] + }, + "model": "ShortTermEnergyOutlook" + } + }, + "/famafrench/factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fama-French factors.\n\nMetadata for the selected dataset are returned in the\n`extra['results_metadata']` field of the response.\n\nSource\n------\n\nhttps://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html\n\nAll returns are in U.S. dollars, include dividends and capital gains,\nand are not continuously compounded.\n\nMarket is the return on a region's value-weight market portfolio\nminus the U.S. one month T-bill rate.\n\nThe Fama/French 5 factors (2x3) are constructed using the 6,\nvalue-weight, portfolios formed on size and book-to-market, the 6,\nvalue-weight, portfolios formed on size and operating profitability,\nand the 6, value-weight, portfolios formed on size and investment.\n\nTo construct the SMB, HML, RMW, and CMA factors, we sort stocks in a\nregion into two market cap and three respective book-to-market equity (B/M),\noperating profitability (OP), and investment (INV) groups at the end of each June.\n\nBig stocks are those in the top 90% of June market cap for the region,\nand small stocks are those in the bottom 10%.\nThe B/M, OP, and INV breakpoints for a region are the 30th and 70th percentiles\nof respective ratios for the big stocks of the region.\n\nRm\u2013Rf for July of year t to June of t+1 include all stocks\nfor which we have market equity data for June of t.\nSMB, HML, RMW, and CMA for July of year t to June of t+1 include all stocks\nfor which we have market equity data for December of t-1\nand June of t, (positive) book equity data for t-1 (for SMB, HML, and RMW),\nnon-missing revenues and at least one of the following: cost of goods sold,\nselling, general and administrative expenses, or interest expense for\nt-1 (for SMB and RMW), and total assets data for t-2 and t-1 (for SMB and CMA).\n\nThe momentum and short term reversal portfolios are reconstituted monthly\nand the other research portfolios are reconstituted annually.\nWe reconstruct the full history of returns each month when we update the portfolios.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fama-French 3-factors data for America, default is monthly.\nobb.famafrench.factors(provider='famafrench')\n# Fama-French 5-factors data for Europe.\nobb.famafrench.factors(provider='famafrench', region='europe', factor='5_factors')\n```\n\n", + "parameters": { + "standard": [], + "famafrench": [ + { + "name": "region", + "type": "str | None", + "description": "Region of focus. Default is America.", + "default": "america", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "America", + "value": "" + }, + { + "label": "North America", + "value": "North_America" + }, + { + "label": "Europe", + "value": "Europe" + }, + { + "label": "Japan", + "value": "Japan" + }, + { + "label": "Asia Pacific Ex Japan", + "value": "Asia_Pacific_ex_Japan" + }, + { + "label": "Developed", + "value": "Developed" + }, + { + "label": "Developed Ex Us", + "value": "Developed_ex_US" + }, + { + "label": "Emerging", + "value": "Emerging_Markets" + } + ] + } + } + }, + { + "name": "factor", + "type": "str | None", + "description": "Factor to fetch. Default is the 3-Factor Model.Short/long-term reversals are available only for America.", + "default": "3_factors", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/famafrench/factor_choices", + "optionsParams": { + "region": "$region", + "is_portfolio": false + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency of the factor data.Not all are available for all regions, and intervals depend on the factor selected. Weekly is only available for the US 3-Factor Model.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/famafrench/get_factor_choices", + "optionsParams": { + "region": "$region", + "factor": "$factor", + "is_portfolio": false + } + } + } + }, + { + "name": "start_date", + "type": "date | None", + "description": "Start date of the data. Defaults to the complete data range.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate-5y", + "description": "Start date of the factor data." + } + } + }, + { + "name": "end_date", + "type": "date | None", + "description": "End date of the data. Defaults to the complete data range.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "$currentDate", + "description": "End date of the factor data." + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FamaFrenchFactors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "famafrench": [ + { + "name": "date", + "type": "date | str", + "description": "Date of the factor data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mkt_rf", + "type": "float | None", + "description": "Excess return on the market, value-weighted return of all firms, minus the one-month Treasury bill rate. Not returned for momentum or reversal factors. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "smb", + "type": "float | None", + "description": "Small minus big (SMB) factor returns. Average return of small minus big stock portfolios. Not returned for momentum or reversal factors. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "hml", + "type": "float | None", + "description": "High minus low (HML) factor returns. Average return on value minus average return on growth portfolios. Not returned for momentum or reversal factors. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "rmw", + "type": "float | None", + "description": "Robust minus weak (RMW) factor returns. Average return on robust operating profitability portfolios, minus average return on weak operating profitability portfolios. Only returned when 5 Factor model is selected. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "cma", + "type": "float | None", + "description": "Conservative minus aggressive (CMA) factor returns. Average return on conservative investment portfolios, minus average return on aggressive investment portfolios. Only returned when 5 Factor model is selected. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "rf", + "type": "float | None", + "description": "Risk-free rate (RF) returns. The one-month US Treasury bill rate. Not returned when momentum or reversal factors are selected. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "mom", + "type": "float | None", + "description": "Momentum (Mom) factor returns. Returned only when the momentum factor is selected and the region is 'america'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "wml", + "type": "float | None", + "description": "Winners minus losers (WML) factor returns. Equal-weight average of the returns for the winner portfolios minus the average of the returns for the loser portfolios. Returned only when the momentum factor is selected, and the region is not 'america'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "lt_rev", + "type": "float | None", + "description": "Long-term reversal (LT_Rev) factor returns. Returned only when the long-term reversal factor is selected, and the region is 'america'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "st_rev", + "type": "float | None", + "description": "Short-term reversal (ST_Rev) factor returns. Returned only when the short-term reversal factor is selected, and the region is 'america'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FamaFrenchFactors", + "openapi_extra": { + "model": "FamaFrenchFactors" + } + }, + "/famafrench/us_portfolio_returns": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "US Portfolio returns.\n\nMetadata for the selected dataset are returned in the\n`extra['results_metadata']` field of the response.\n\nSource\n------\n\nhttps://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html\n\nAll returns are in U.S. dollars, include dividends (unless the portfolio is 'wout_div')\nand capital gains, and are not continuously compounded.\n\n\nThe momentum and short term reversal portfolios are reconstituted monthly\nand the other research portfolios are reconstituted annually.\nWe reconstruct the full history of returns each month when we update the portfolios.\n\n\nSize and Book-to-Market Portfolios\n----------------------------------\n\n- Small Value\n- Small Neutral\n- Small Growth\n- Big Value\n- Big Neutral\n- Big Growth\n\nBE < 0; bottom 30%, middle 40%, top 30%; quintiles; deciles.\nFirms with negative book equity are in only the BE < 0 portfolio.\n\nSize and Operating Profitability Portfolios\n-------------------------------------------\n\n- Small Robust\n- Small Neutral\n- Small Weak\n- Big Robust\n- Big Neutral\n- Big Weak\n\nOperating Profitability bottom 30%, middle 40%, top 30%; quintiles; deciles.\n\nSize and Investment Portfolios\n------------------------------\n\n- Small Conservative\n- Small Neutral\n- Small Aggressive\n- Big Conservative\n- Big Neutral\n- Big Aggressive\n\nME < 0 (not used); bottom 30%, middle 40%, top 30%; quintiles; deciles.\nInvestment bottom 30%, middle 40%, top 30%; quintiles; deciles.\n\nDefinitions\n-----------\n\nME : Market Equity\n\nMarket equity (size) is price times shares outstanding.\nPrice and shares outstanding are from CRSP.\n\nBE : Book Equity\n\nBook equity is constructed from Compustat data or collected from the\nMoody\u2019s Industrial, Financial, and Utilities manuals.\nBE is the book value of stockholders\u2019 equity, plus balance sheet deferred taxes\nand investment tax credit (if available), minus the book value of preferred stock.\nDepending on availability, we use the redemption, liquidation, or par value (in that order)\nto estimate the book value of preferred stock. Stockholders\u2019 equity is the value reported\nby Moody\u2019s or Compustat, if it is available. If not, we measure stockholders\u2019 equity as\nthe book value of common equity plus the par value of preferred stock,\nor the book value of assets minus total liabilities (in that order).\n\nSee Davis, Fama, and French, 2000,\n\u201cCharacteristics, Covariances, and Average Returns: 1929-1997\u201d\nJournal of Finance, for more details.\n\nBE/ME : Book-to-Market\n\nThe book-to-market ratio used to form portfolios in June of year t is book equity\nfor the fiscal year ending in calendar year t-1,\ndivided by market equity at the end of December of t-1.\n\nOP : Operating Profitability\n\nThe operating profitability ratio used to form portfolios in June of year t is annual revenues\nminus cost of goods sold, interest expense, and selling, general, and administrative expense\ndivided by the sum of book equity and minority interest for the last fiscal year ending in t-1.\n\nINV : Investment\n\nThe investment ratio used to form portfolios in June of year t is the change in total assets\nfrom the fiscal year ending in year t-2 to the fiscal year ending in t-1,\ndivided by t-2 total assets.\n\nE/P : Earnings/Price\n\nEarnings is total earnings before extraordinary items, from Compustat.\nThe earnings/price ratio used to form portfolios in June of year t is earnings\nfor the fiscal year ending in calendar year t-1,\ndivided by market equity at the end of December of t-1.\n\nCF/P : Cashflow/Price\n\nCashflow is total earnings before extraordinary items, plus equity\u2019s share of depreciation,\nplus deferred taxes (if available), from Compustat. Equity\u2019s share is defined as market equity\ndivided by assets minus book equity plus market equity.\nThe cashflow/price ratio used to form portfolios in June of year t is the cashflow for the\nfiscal year ending in calendar year t-1, divided by market equity at the end of December of t-1.\n\nD/P : Dividend Yield\n\nThe dividend yield used to form portfolios in June of year t is the total dividends paid\nfrom July of t-1 to June of t per dollar of equity in June of t.\nThe dividend yield is computed using the with and without dividend returns from CRSP,\nas described in Fama and French, 1988, \u201cDividend yields and expected stock returns,\u201d\nJournal of Financial Economics 25.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get model US portfolio returns used for constructing the Fama-French Factor models.\nobb.famafrench.us_portfolio_returns(provider='famafrench')\n# If the portfolio name does not have a frequency - i.e. '_daily' - use the frequency parameter to specify the interval.\nobb.famafrench.us_portfolio_returns(provider='famafrench', portfolio='5_industry_portfolios_wout_div', frequency='annual', measure='equal')\n```\n\n", + "parameters": { + "standard": [], + "famafrench": [ + { + "name": "portfolio", + "type": "str | None", + "description": "The specific portfolio file to fetch.", + "default": "portfolios_formed_on_me", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [] + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "The measure to fetch for the portfolio.", + "default": "value", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data to fetch. Ignored if the portfolio ends with 'daily' or 'weekly'.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date for the data. Defaults to the earliest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date for the data. Defaults to the latest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FamaFrenchUSPortfolioReturns", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "famafrench": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portfolio", + "type": "str", + "description": "The individual portfolio formation within the portfolio file.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "measure", + "type": "str", + "description": "The measure of the portfolio.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "The value represented by the 'measure'. Returns are in percent for the 'value' and 'equal' measures. None where the source reports missing data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FamaFrenchUSPortfolioReturns", + "openapi_extra": { + "widget_config": { + "name": "Fama-French US Portfolio Returns" + }, + "model": "FamaFrenchUSPortfolioReturns" + } + }, + "/famafrench/regional_portfolio_returns": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Regional portfolio returns.\n\nMetadata for the selected dataset are returned in the\n`extra['results_metadata']` field of the response.\n\nSee the `us_portfolio_returns` endpoint for more details.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get model Regional portfolio returns used for constructing the Fama-French Factor models.\nobb.famafrench.regional_portfolio_returns(provider='famafrench')\n# Get portfolios formed by equal-weight, with annual returns.\nobb.famafrench.regional_portfolio_returns(provider='famafrench', frequency='annual', measure='equal')\n```\n\n", + "parameters": { + "standard": [], + "famafrench": [ + { + "name": "portfolio", + "type": "str | None", + "description": "The specific portfolio file to fetch.", + "default": "developed_ex_us_6_portfolios_me_op", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [] + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "The measure to fetch for the portfolio.", + "default": "value", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data to fetch. Ignored when the portfolio ends with 'daily'.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date for the data. Defaults to the earliest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date for the data. Defaults to the latest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FamaFrenchRegionalPortfolioReturns", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "famafrench": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portfolio", + "type": "str", + "description": "The individual portfolio formation within the portfolio file.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "measure", + "type": "str", + "description": "The measure of the portfolio.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "The value represented by the 'measure'. Returns are in percent for the 'value' and 'equal' measures. None where the source reports missing data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FamaFrenchRegionalPortfolioReturns", + "openapi_extra": { + "model": "FamaFrenchRegionalPortfolioReturns" + } + }, + "/famafrench/country_portfolio_returns": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Country portfolio returns.\n\nMetadata for the selected dataset are returned in the\n`extra['results_metadata']` field of the response.\n\nSource\n------\n\nhttps://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html\n\nWe form value and growth portfolios in each country using four valuation ratios:\n\n- book-to-market (B/M)\n- earnings-price (E/P)\n- cash earnings to price (CE/P)\n- dividend yield (D/P)\n\nWe form the portfolios at the end of December each year by sorting on one of the four ratios and\nthen compute value-weighted returns for the following 12 months.\n\nThe value portfolios (High) contain firms in the top 30% of a ratio\nand the growth portfolios (Low) contain firms in the bottom 30%.\n\nThere are two sets of portfolios.\n\nIn one, firms are included only if we have data on all four ratios.\n\nIn the other, a firm is included in a sort variable's portfolios\nif we have data for that variable.\n\nThe market return (Mkt) for the first set is the value weighted average of the returns\nfor only firms with all four ratios.\n\nThe market return for the second set includes all firms with book-to-market data,\nand Firms is the number of firms with B/M data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get model Country portfolio returns used for constructing the Fama-French Factor models.\nobb.famafrench.country_portfolio_returns(provider='famafrench')\n# Parameters are different than the regional and US portfolio returns.\nobb.famafrench.country_portfolio_returns(provider='famafrench', frequency='annual', measure='local', country='japan', dividends=False, all_data_items_required=False)\n```\n\n", + "parameters": { + "standard": [], + "famafrench": [ + { + "name": "country", + "type": "str | None", + "description": "Country to fetch the portfolio returns for.", + "default": "united_kingdom", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "value": "austria", + "label": "Austria" + }, + { + "value": "australia", + "label": "Australia" + }, + { + "value": "belgium", + "label": "Belgium" + }, + { + "value": "canada", + "label": "Canada" + }, + { + "value": "denmark", + "label": "Denmark" + }, + { + "value": "finland", + "label": "Finland" + }, + { + "value": "france", + "label": "France" + }, + { + "value": "germany", + "label": "Germany" + }, + { + "value": "hong_kong", + "label": "Hong Kong" + }, + { + "value": "ireland", + "label": "Ireland" + }, + { + "value": "italy", + "label": "Italy" + }, + { + "value": "japan", + "label": "Japan" + }, + { + "value": "malaysia", + "label": "Malaysia" + }, + { + "value": "netherlands", + "label": "Netherlands" + }, + { + "value": "new_zealand", + "label": "New Zealand" + }, + { + "value": "norway", + "label": "Norway" + }, + { + "value": "singapore", + "label": "Singapore" + }, + { + "value": "spain", + "label": "Spain" + }, + { + "value": "sweden", + "label": "Sweden" + }, + { + "value": "switzerland", + "label": "Switzerland" + }, + { + "value": "united_kingdom", + "label": "United Kingdom" + } + ] + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'.", + "default": "usd", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividends", + "type": "bool | None", + "description": "When False, portoflios exclude dividends.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "all_data_items_required", + "type": "bool | None", + "description": "If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date for the data. Defaults to the earliest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date for the data. Defaults to the latest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FamaFrenchCountryPortfolioReturns", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "famafrench": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mkt", + "type": "float | None", + "description": "Value-weighted market return (Mkt). Includes only firms with all four ratios when `all_data_items_required` is True, otherwise all firms with book-to-market data. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "firms", + "type": "int | None", + "description": "The number of firms, relative to `all_data_items_required` parameter. Only returned when `measure` is set to 'ratios'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bm", + "type": "float | None", + "description": "Book to Market equity ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "be_me_high", + "type": "float | None", + "description": "Book Equity to Market Equity returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "be_me_low", + "type": "float | None", + "description": "Book Equity to Market Equity returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "ep", + "type": "float | None", + "description": "Earnings to Price ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "e_p_high", + "type": "float | None", + "description": "Earnings to Price returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "e_p_low", + "type": "float | None", + "description": "Earnings to Price returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "ce_p", + "type": "float | None", + "description": "Cash Earnings to Price ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ce_p_high", + "type": "float | None", + "description": "Cash Earnings to Price returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "ce_p_low", + "type": "float | None", + "description": "Cash Earnings to Price returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yld", + "type": "float | None", + "description": "Dividend Yield ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "yld_high", + "type": "float | None", + "description": "Dividend Yield returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yld_low", + "type": "float | None", + "description": "Dividend Yield returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yld_zero", + "type": "float | None", + "description": "Dividend Yield returns for firms not paying dividends. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FamaFrenchCountryPortfolioReturns", + "openapi_extra": { + "model": "FamaFrenchCountryPortfolioReturns" + } + }, + "/famafrench/international_index_returns": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "International index returns.\n\nMetadata for the selected dataset are returned in the\n`extra['results_metadata']` field of the response.\n\nSee the `country_portfolio_returns` endpoint for more details.\n\nSource\n------\n\nhttps://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html\n\nThe returns on the index portfolios are constructed by\naveraging the returns on the country portfolios.\n\nWe weight countries in the index portfolios in proportion to their EAFE + Canada weights.\n\nEach country is added to the index portfolios when the return data for the country begin;\nthe country start dates can be inferred from the country return files.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get benchmark index returns used for constructing the international Fama-French Factor models.\nobb.famafrench.international_index_returns(provider='famafrench')\n# Parameters are similar to the country portfolio returns.\nobb.famafrench.international_index_returns(provider='famafrench', frequency='annual', measure='ratios', index='europe_ex_uk', dividends=False, all_data_items_required=False)\n```\n\n", + "parameters": { + "standard": [], + "famafrench": [ + { + "name": "index", + "type": "str | None", + "description": "International index to fetch the portfolio returns for. Defaults to 'all'.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "measure", + "type": "str | None", + "description": "The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'.", + "default": "usd", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividends", + "type": "bool | None", + "description": "When False, portoflios exclude dividends.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "all_data_items_required", + "type": "bool | None", + "description": "If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date for the data. Defaults to the earliest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date for the data. Defaults to the latest available date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FamaFrenchInternationalIndexReturns", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "famafrench": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mkt", + "type": "float | None", + "description": "Value-weighted market return (Mkt). Includes only firms with all four ratios when `all_data_items_required` is True, otherwise all firms with book-to-market data. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "firms", + "type": "int | None", + "description": "The number of firms, relative to `all_data_items_required` parameter. Only returned when `measure` is set to 'ratios'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bm", + "type": "float | None", + "description": "Book to Market equity ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "be_me_high", + "type": "float | None", + "description": "Book Equity to Market Equity returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "be_me_low", + "type": "float | None", + "description": "Book Equity to Market Equity returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "ep", + "type": "float | None", + "description": "Earnings to Price ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "e_p_high", + "type": "float | None", + "description": "Earnings to Price returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "e_p_low", + "type": "float | None", + "description": "Earnings to Price returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "ce_p", + "type": "float | None", + "description": "Cash Earnings to Price ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ce_p_high", + "type": "float | None", + "description": "Cash Earnings to Price returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "ce_p_low", + "type": "float | None", + "description": "Cash Earnings to Price returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yld", + "type": "float | None", + "description": "Dividend Yield ratio. Only returned when `measure` is set to 'ratios'. Reported as the ratio multiplied by 100.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "yld_high", + "type": "float | None", + "description": "Dividend Yield returns for the value portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yld_low", + "type": "float | None", + "description": "Dividend Yield returns for the growth portfolio. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yld_zero", + "type": "float | None", + "description": "Dividend Yield returns for firms not paying dividends. Not returned if `measure` is set to 'ratios'. Values are in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FamaFrenchInternationalIndexReturns", + "openapi_extra": { + "model": "FamaFrenchInternationalIndexReturns" + } + }, + "/famafrench/breakpoints": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fama-French breakpoints.\n\nMetadata for the selected dataset are returned in the\n`extra['results_metadata']` field of the response.\n\nSource\n------\n\nhttps://mba.tuck.dartmouth.edu/pages/faculty/ken.french/data_library.html#Breakpoints", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get US breakpoints used for constructing the research portfolios.\nobb.famafrench.breakpoints(provider='famafrench')\n# See the parameters description for details on the breakpoints.\nobb.famafrench.breakpoints(provider='famafrench', breakpoint='op', start_date='1998-01-01')\n```\n\n", + "parameters": { + "standard": [], + "famafrench": [ + { + "name": "breakpoint_type", + "type": "str | None", + "description": "Type of breakpoint to fetch.\n\nThe breakpoints for month t use all NYSE stocks that have a CRSP share code of 10 or 11\nand have good shares and price data. We exclude closed end funds and REITs.\n\nBreakpoints are computed either monthly or annually, see the description of each breakpoint type below.\n\nData contains every fifth percentile, from 5% to 100%.\n\nME\n--\n\nMarket Equity. Market equity (size) is price times shares outstanding.\nPrice and shares outstanding are from CRSP.\n\nME breakpoints are computed for each month.\nIt is price times shares outstanding (divided by 1,000,000) at month end.\n\nBE/ME\n-----\n\nBE/ME breakpoints are computed at the end of each June.\nThe BE used in June of year t is the book equity for the last fiscal year end in t-1.\nME is price times shares outstanding at the end of December of t-1.\n\nThe breakpoints for year t use all NYSE stocks for which we have ME for December of t-1\nand (positive) BE for the last fiscal year end in t-1.\n\nOperating Profitability\n-----------------------\n\nOperating Profitability breakpoints are computed at the end of each June.\nOP for June of year t is annual revenues minus\n\n- cost of goods sold\n- interest expense\n- selling, general, and administrative expenses\n\ndivided by book equity for the last fiscal year end in t-1.\n\nPlease be aware that some of the value-weight averages of operating profitability for deciles 1 and 10 are extreme.\nThese are driven by extraordinary values of OP for individual firms.\nWe have spot checked the accounting data that produce the extraordinary values\nand all the numbers we examined accurately reflect the data in the firm's accounting statements.\n\nThe breakpoints for year t use all NYSE stocks for which we have (positive) book equity data for t-1,\nnon-missing revenues data for t-1, and non-missing data for at least one of the following:\n\n- cost of goods sold\n- selling, general and administrative expenses\n- interest expense for t-1.\n\nInvestment\n----------\n\nInvestment breakpoints are computed at the end of each June.\nInv used in June of year t is the change in total assets from the fiscal year ending in year t-2\nto the fiscal year ending in t-1, divided by t-2 total assets.\n\nThe breakpoints for year t use all NYSE stocks for which we have total assets data for t-2 and t-1.\n\nE/P\n---\n\nE/P (in percent) breakpoints are computed at the end of each June.\nThe E used in June of year t is the earnings for the last fiscal year end in t-1.\nP (actually ME) is price times shares outstanding at the end of December of t-1.\n\nThe breakpoints for year t use all NYSE stocks for which we have ME for December of t-1\nand (positive) earnings for the last fiscal year end in t-1.\n\nCF/P\n----\n\nCF/P (in percent) breakpoints is computed at the end of each June.\nThe CF used in June of year t is the cash flow for the last fiscal year end in t-1.\nP (actually ME) is price times shares outstanding at the end of December of t-1.\n\nThe breakpoints for year t use all NYSE stocks for which we have ME for December of t-1\nand (positive) cash flow for the last fiscal year end in t-1.\n\nD/P\n---\n\nD/P (in percent) breakpoints are computed at the end of each June.\nThe dividend yield in June of year t is the total dividends paid from July of t-1\nto June of t per dollar of equity in June of t.\n\nThe breakpoints for year t use NYSE stocks for which we have at least\nseven months (to compute the dividend yield) from July of t-1 to June of t.\n(Only six monthly returns are required in June 1926.)\nWe do not include stocks that pay no dividends from July of t-1 to June of t.\n\nPrior 2-12\n----------\n\nPrior return breakpoints are computed for each month.\nThe prior return at the end of month t is the cumulative return from month t-11 to month t-1.\n\nThe breakpoints for month t use NYSE stocks.\nTo be included, a stock must have a price for the end of month t-12 and a good return for t-1.\nIn addition, any missing returns from t-11 to t-2 must be -99.0, CRSP's code for a missing price.", + "default": "me", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date for the data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date for the data.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FamaFrenchBreakpoints", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "famafrench": [ + { + "name": "date", + "type": "date | str", + "description": "Date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "num_firms", + "type": "int | None", + "description": "Number of firms in the sample. Not returned for BE/ME breakpoints.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "num_firms_less_than_0", + "type": "int | None", + "description": "Number of firms with ratio less than or equal to 0. This is only applicable for ratio breakpoints.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "num_firms_greater_than_0", + "type": "int | None", + "description": "Number of firms with ratio greater than 0. This is only applicable for ratio breakpoints.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percentile_5", + "type": "float", + "description": "Fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_10", + "type": "float", + "description": "Tenth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_15", + "type": "float", + "description": "Fifteenth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_20", + "type": "float", + "description": "Twentieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_25", + "type": "float", + "description": "Twenty-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_30", + "type": "float", + "description": "Thirtieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_35", + "type": "float", + "description": "Thirty-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_40", + "type": "float", + "description": "Fortieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_45", + "type": "float", + "description": "Forty-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_50", + "type": "float", + "description": "Fiftieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_55", + "type": "float", + "description": "Fifty-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_60", + "type": "float", + "description": "Sixtieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_65", + "type": "float", + "description": "Sixty-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_70", + "type": "float", + "description": "Seventieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_75", + "type": "float", + "description": "Seventy-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_80", + "type": "float", + "description": "Eightieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_85", + "type": "float", + "description": "Eighty-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_90", + "type": "float", + "description": "Ninetieth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_95", + "type": "float", + "description": "Ninety-fifth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percentile_100", + "type": "float", + "description": "Hundredth percentile of the sample.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FamaFrenchBreakpoints", + "openapi_extra": { + "model": "FamaFrenchBreakpoints" + } + }, + "/federal_reserve/list_releases": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List Federal Reserve Data Download Program (DDP) statistical releases.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # List the Federal Reserve statistical releases available via the Data Download Program.\n >>> obb.federal_reserve.list_releases()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List the Federal Reserve statistical releases available via the Data Download Program.\nobb.federal_reserve.list_releases()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Federal Reserve Statistical Releases", + "description": "The statistical releases published through the Federal Reserve Data Download Program. Click a release to load its data tables and series.", + "gridData": { + "w": 20, + "h": 18 + }, + "data": { + "table": { + "showAll": false, + "columnsDefs": [ + { + "field": "dataset", + "headerName": "Release", + "cellDataType": "text", + "formatterFn": "none", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "dataset" + } + } + }, + { + "field": "name", + "headerName": "Name", + "cellDataType": "text" + } + ] + } + } + }, + "model": "" + } + }, + "/federal_reserve/list_datasets": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the data tables available within a Federal Reserve DDP release.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List the data tables within a release.\nobb.federal_reserve.list_datasets(dataset='H.15')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataset", + "type": "str", + "description": "", + "default": "H.15", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Release Data Tables", + "description": "The data tables available within a Federal Reserve statistical release. Click a table to load its time series.", + "gridData": { + "w": 20, + "h": 18 + }, + "data": { + "table": { + "showAll": false, + "columnsDefs": [ + { + "field": "table", + "headerName": "Table", + "cellDataType": "text", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "table" + } + } + }, + { + "field": "dataset", + "headerName": "Release", + "cellDataType": "text", + "formatterFn": "none" + }, + { + "field": "release_name", + "headerName": "Release Name", + "cellDataType": "text" + } + ] + } + } + }, + "model": "" + } + }, + "/federal_reserve/release_calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Federal Reserve statistical release publication schedule.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The upcoming and recent Federal Reserve release schedule.\nobb.federal_reserve.release_calendar()\n# The release schedule from a start date.\nobb.federal_reserve.release_calendar(start_date='2026-01-01')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Federal Reserve Release Calendar", + "description": "The publication schedule of Federal Reserve statistical releases (federalreserve.gov/data/releaseschedule.htm). Click a release to load its data tables and series.", + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "showAll": false, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "asc" + }, + { + "field": "time", + "headerName": "Time", + "cellDataType": "text" + }, + { + "field": "release", + "headerName": "Release", + "cellDataType": "text", + "formatterFn": "none", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "dataset" + } + } + }, + { + "field": "title", + "headerName": "Title", + "cellDataType": "text" + }, + { + "field": "event_type", + "headerName": "Type", + "cellDataType": "text" + } + ] + } + } + }, + "model": "" + } + }, + "/federal_reserve/fed_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch any published Federal Reserve dataset from the Data Download Program.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fetch a release's first table.\nobb.federal_reserve.fed_data(dataset='H.15', provider='federal_reserve')\n# Fetch a specific table within a release.\nobb.federal_reserve.fed_data(dataset='H.15', table='Monthly Averages', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "dataset", + "type": "str", + "description": "The Federal Reserve statistical release to download.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "H.6 \u2014 Money Stock Measures", + "value": "H.6" + }, + { + "label": "H.8 \u2014 Assets and Liabilities of Commercial Banks", + "value": "H.8" + }, + { + "label": "H.10 \u2014 Foreign Exchange Rates", + "value": "H.10" + }, + { + "label": "H.15 \u2014 Selected Interest Rates", + "value": "H.15" + }, + { + "label": "H.4.1 \u2014 Factors Affecting Reserve Balances", + "value": "H.4.1" + }, + { + "label": "G.17 \u2014 Industrial Production and Capacity Utilization", + "value": "G.17" + }, + { + "label": "G.19 \u2014 Consumer Credit", + "value": "G.19" + }, + { + "label": "G.20 \u2014 Finance Companies", + "value": "G.20" + }, + { + "label": "Z.1 \u2014 Financial Accounts of the United States", + "value": "Z.1" + }, + { + "label": "CP \u2014 Commercial Paper", + "value": "CP" + }, + { + "label": "CHGDEL \u2014 Charge-off and Delinquency Rates", + "value": "CHGDEL" + }, + { + "label": "DSR \u2014 Household Debt Service and Financial Obligations Ratios", + "value": "DSR" + }, + { + "label": "SLOOS \u2014 Senior Loan Officer Opinion Survey", + "value": "SLOOS" + }, + { + "label": "SCOOS \u2014 Senior Credit Officer Opinion Survey", + "value": "SCOOS" + } + ] + } + } + }, + { + "name": "table", + "type": "str | None", + "description": "The data table within the release (see `list_datasets`); defaults to the release's first table.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Optional comma-separated series IDs to filter the table to.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "seasonally_adjusted", + "type": "bool | None", + "description": "Filter to seasonally adjusted (True) or not seasonally adjusted (False) series; defaults to both, where applicable.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Return only the most recent N observations per series; the default is the latest observation. Set to 0 or None for the full series. When the full series is already cached, it is sliced from the cache.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDataDownload", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str", + "description": "The DDP series identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The observation value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Human-readable series description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of the value, including scale, e.g. 'Millions of Dollars' or 'Percent: Per Year'. Values are published as-is, not rescaled.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit_multiplier", + "type": "str | None", + "description": "The scale word applied to the value, e.g. 'Millions', 'Billions', or 'Trillions'; None when the value carries no scale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seasonally_adjusted", + "type": "bool | None", + "description": "Whether the series is seasonally adjusted, where applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDataDownload", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Federal Reserve Data Download (DDP)", + "description": "Any published Federal Reserve dataset retrieved from the Data Download Program by release and table.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "series_id", + "headerName": "Series ID", + "cellDataType": "text", + "formatterFn": "none", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "series" + } + } + } + ] + } + } + }, + "model": "FederalReserveDataDownload" + } + }, + "/federal_reserve/money_market_funds": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Money Market Funds Investment Holdings (Enhanced Financial Accounts).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get total money market fund investment holdings by category.\nobb.federal_reserve.money_market_funds(table='total', provider='federal_reserve')\n# Get prime fund holdings detail for a single country.\nobb.federal_reserve.money_market_funds(table='detail', country='Japan', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The Enhanced Financial Accounts table: total/prime/government/exempt holdings, by-fund-type holdings, country detail, commercial paper, or repo.", + "default": "total", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Total money market funds investment holdings", + "value": "total" + }, + { + "label": "Prime money market funds investment holdings", + "value": "prime" + }, + { + "label": "Government money market funds investment holdings", + "value": "government" + }, + { + "label": "Tax-exempt money market funds investment holdings", + "value": "exempt" + }, + { + "label": "Money market funds investment holdings by fund type", + "value": "holdings" + }, + { + "label": "Money market funds investment holdings country detail", + "value": "detail" + }, + { + "label": "Money market fund commercial paper holdings", + "value": "commercial_paper" + }, + { + "label": "Repo money market funds holdings", + "value": "repo" + } + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Filter to a single country (the detail tables only).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMoneyMarketFunds", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMoneyMarketFunds", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Money Market Fund Holdings (EFA)", + "description": "Money market fund investment holdings, in millions of dollars, from the Enhanced Financial Accounts.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left" + } + ] + } + } + }, + "model": "FederalReserveMoneyMarketFunds" + } + }, + "/federal_reserve/international_portfolio_investment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get International Portfolio Investment holdings (Enhanced Financial Accounts).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get foreign residents' holdings of total U.S. long-term securities by country.\nobb.federal_reserve.international_portfolio_investment(table='table1', provider='federal_reserve')\n# Get U.S. residents' holdings of foreign corporate stocks for a single country.\nobb.federal_reserve.international_portfolio_investment(table='table2b', country='Japan', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The holdings table: foreign residents' holdings of U.S. securities - total (table1), Treasury (1a), agency (1b), corporate bonds (1c), stocks (1d), short-term Treasury memo (1e); or U.S. residents' holdings of foreign securities - total (table2), bonds (2a), stocks (2b).", + "default": "table1", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Foreign residents' holdings of total U.S. long-term securities", + "value": "table1" + }, + { + "label": "Foreign residents' holdings of U.S. long-term Treasury securities", + "value": "table1a" + }, + { + "label": "Foreign residents' holdings of U.S. long-term agency bonds", + "value": "table1b" + }, + { + "label": "Foreign residents' holdings of U.S. long-term corporate and other bonds", + "value": "table1c" + }, + { + "label": "Foreign residents' holdings of U.S. corporate stocks", + "value": "table1d" + }, + { + "label": "Foreign residents' holdings of U.S. short-term Treasury securities (memo)", + "value": "table1e" + }, + { + "label": "U.S. residents' holdings of total foreign long-term securities", + "value": "table2" + }, + { + "label": "U.S. residents' holdings of foreign long-term bonds", + "value": "table2a" + }, + { + "label": "U.S. residents' holdings of foreign corporate stocks", + "value": "table2b" + } + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Filter to a single country or region (matched in the path).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveInternationalPortfolioInvestment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "The country or region.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveInternationalPortfolioInvestment", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "International Portfolio Investment (EFA)", + "description": "Cross-border holdings of long-term securities, from the Enhanced Financial Accounts project.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left" + }, + { + "field": "country", + "headerName": "Country", + "cellDataType": "text", + "pinned": "left" + } + ] + } + } + }, + "model": "FederalReserveInternationalPortfolioInvestment" + } + }, + "/federal_reserve/fomc_documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get lists of FOMC documents by year and document type.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.fomc_documents(provider='federal_reserve')\n# Filter all documents by year.\nobb.federal_reserve.fomc_documents(provider='federal_reserve', year=2022)\n# Filter all documents by year and document type.\nobb.federal_reserve.fomc_documents(provider='federal_reserve', year=2022, document_type='minutes')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "year", + "type": "int | None", + "description": "The year of FOMC documents to retrieve. If None, all years since 1959 are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number", + "value": null, + "options": [ + { + "label": "All Years", + "value": null + }, + { + "label": "2026", + "value": 2026 + }, + { + "label": "2025", + "value": 2025 + }, + { + "label": "2024", + "value": 2024 + }, + { + "label": "2023", + "value": 2023 + }, + { + "label": "2022", + "value": 2022 + }, + { + "label": "2021", + "value": 2021 + }, + { + "label": "2020", + "value": 2020 + }, + { + "label": "2019", + "value": 2019 + }, + { + "label": "2018", + "value": 2018 + }, + { + "label": "2017", + "value": 2017 + }, + { + "label": "2016", + "value": 2016 + }, + { + "label": "2015", + "value": 2015 + }, + { + "label": "2014", + "value": 2014 + }, + { + "label": "2013", + "value": 2013 + }, + { + "label": "2012", + "value": 2012 + }, + { + "label": "2011", + "value": 2011 + }, + { + "label": "2010", + "value": 2010 + }, + { + "label": "2009", + "value": 2009 + }, + { + "label": "2008", + "value": 2008 + }, + { + "label": "2007", + "value": 2007 + }, + { + "label": "2006", + "value": 2006 + }, + { + "label": "2005", + "value": 2005 + }, + { + "label": "2004", + "value": 2004 + }, + { + "label": "2003", + "value": 2003 + }, + { + "label": "2002", + "value": 2002 + }, + { + "label": "2001", + "value": 2001 + }, + { + "label": "2000", + "value": 2000 + }, + { + "label": "1999", + "value": 1999 + }, + { + "label": "1998", + "value": 1998 + }, + { + "label": "1997", + "value": 1997 + }, + { + "label": "1996", + "value": 1996 + }, + { + "label": "1995", + "value": 1995 + }, + { + "label": "1994", + "value": 1994 + }, + { + "label": "1993", + "value": 1993 + }, + { + "label": "1992", + "value": 1992 + }, + { + "label": "1991", + "value": 1991 + }, + { + "label": "1990", + "value": 1990 + }, + { + "label": "1989", + "value": 1989 + }, + { + "label": "1988", + "value": 1988 + }, + { + "label": "1987", + "value": 1987 + }, + { + "label": "1986", + "value": 1986 + }, + { + "label": "1985", + "value": 1985 + }, + { + "label": "1984", + "value": 1984 + }, + { + "label": "1983", + "value": 1983 + }, + { + "label": "1982", + "value": 1982 + }, + { + "label": "1981", + "value": 1981 + }, + { + "label": "1980", + "value": 1980 + }, + { + "label": "1979", + "value": 1979 + }, + { + "label": "1978", + "value": 1978 + }, + { + "label": "1977", + "value": 1977 + }, + { + "label": "1976", + "value": 1976 + }, + { + "label": "1975", + "value": 1975 + }, + { + "label": "1974", + "value": 1974 + }, + { + "label": "1973", + "value": 1973 + }, + { + "label": "1972", + "value": 1972 + }, + { + "label": "1971", + "value": 1971 + }, + { + "label": "1970", + "value": 1970 + }, + { + "label": "1969", + "value": 1969 + }, + { + "label": "1968", + "value": 1968 + }, + { + "label": "1967", + "value": 1967 + }, + { + "label": "1966", + "value": 1966 + }, + { + "label": "1965", + "value": 1965 + }, + { + "label": "1964", + "value": 1964 + }, + { + "label": "1963", + "value": 1963 + }, + { + "label": "1962", + "value": 1962 + }, + { + "label": "1961", + "value": 1961 + }, + { + "label": "1960", + "value": 1960 + }, + { + "label": "1959", + "value": 1959 + } + ] + } + } + }, + { + "name": "document_type", + "type": "str | None", + "description": "Filter by document type. Default is all. Choose from: all, monetary_policy, minutes, projections, materials, press_release, press_conference, agenda, transcript, speaker_key, beige_book, teal_book, green_book, blue_book, red_book", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Documents", + "value": null + }, + { + "label": "Monetary Policy", + "value": "monetary_policy" + }, + { + "label": "Minutes", + "value": "minutes" + }, + { + "label": "Projections", + "value": "projections" + }, + { + "label": "Materials", + "value": "materials" + }, + { + "label": "Press Release", + "value": "press_release" + }, + { + "label": "Press Conference", + "value": "press_conference" + }, + { + "label": "Agenda", + "value": "agenda" + }, + { + "label": "Transcript", + "value": "transcript" + }, + { + "label": "Speaker Key", + "value": "speaker_key" + }, + { + "label": "Beige Book", + "value": "beige_book" + }, + { + "label": "Teal Book", + "value": "teal_book" + }, + { + "label": "Green Book", + "value": "green_book" + }, + { + "label": "Blue Book", + "value": "blue_book" + }, + { + "label": "Red Book", + "value": "red_book" + } + ], + "description": "Filter by document type. Default is all." + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveFomcDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the document, formatted as YYYY-MM-DD.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "doc_type", + "type": "str", + "description": "The type of the FOMC document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "doc_format", + "type": "str", + "description": "The format of the document (e.g., pdf, htm).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The URL of the document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveFomcDocuments", + "openapi_extra": { + "model": "FederalReserveFomcDocuments" + } + }, + "/federal_reserve/inflation_expectations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Survey of forward inflation expectations from the Survey of Professional Forecasters.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.inflation_expectations(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Data begins from 1970-04-01 and is quarterly.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveInflationExpectations", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the survey (first day of the survey quarter).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "infpgdp1yr", + "type": "float | None", + "description": "One-year-ahead annual-average GDP price index inflation forecast. Computed from median forecasts of GDP price index levels (PGDP2 and PGDP6). Formula: ((PGDP6/PGDP2) - 1) * 100. Available from 1970:Q2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "infcpi1yr", + "type": "float | None", + "description": "One-year-ahead annual-average CPI inflation forecast. Computed as the geometric average of quarter-over-quarter median CPI forecasts (CPI3 to CPI6). Available from 1981:Q3.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "infcpi10yr", + "type": "float | None", + "description": "Ten-year-ahead annual-average CPI inflation forecast. Expected average annual rate of CPI inflation over the next 10 years. Available from 1991:Q4.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FederalReserveInflationExpectations", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Survey of Professional Forecasters Inflation Expectations", + "description": "One-year-ahead and ten-year-ahead inflation forecasts from the Philadelphia Fed's Survey of Professional Forecasters.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left" + }, + { + "field": "infpgdp1yr", + "headerName": "GDP Deflator Inflation (1-Year)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "infcpi1yr", + "headerName": "CPI Inflation (1-Year)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "infcpi10yr", + "headerName": "CPI Inflation (10-Year)", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveInflationExpectations" + } + }, + "/federal_reserve/money_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Money Measures (M1/M2 and components) from the H.6 Release.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.money_measures(provider='federal_reserve')\nobb.federal_reserve.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "adjusted", + "type": "bool | None", + "description": "Whether to return seasonally adjusted data.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMoneyMeasures", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "month", + "type": "date", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "m1", + "type": "float", + "description": "Value of the M1 money supply in billions.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B", + "headerName": "M1" + } + } + }, + { + "name": "m2", + "type": "float", + "description": "Value of the M2 money supply in billions.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B", + "headerName": "M2" + } + } + }, + { + "name": "currency", + "type": "float | None", + "description": "Value of currency in circulation in billions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + }, + { + "name": "demand_deposits", + "type": "float | None", + "description": "Value of demand deposits in billions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + }, + { + "name": "retail_money_market_funds", + "type": "float | None", + "description": "Value of retail money market funds in billions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + }, + { + "name": "other_liquid_deposits", + "type": "float | None", + "description": "Value of other liquid deposits in billions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + }, + { + "name": "small_denomination_time_deposits", + "type": "float | None", + "description": "Value of small denomination time deposits in billions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "federal_reserve": [ + { + "name": "m1", + "type": "float", + "description": "Value of the M1 money supply in dollars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "m2", + "type": "float", + "description": "Value of the M2 money supply in dollars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "float | None", + "description": "Value of currency in circulation in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand_deposits", + "type": "float | None", + "description": "Value of demand deposits in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "retail_money_market_funds", + "type": "float | None", + "description": "Value of retail money market funds in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_liquid_deposits", + "type": "float | None", + "description": "Value of other liquid deposits in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "small_denomination_time_deposits", + "type": "float | None", + "description": "Value of small denomination time deposits in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMoneyMeasures", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Federal Reserve Money Measures (H.6)", + "description": "M1 and M2 money supply and their components, in dollars, from the Federal Reserve's H.6 release.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "month", + "headerName": "Month", + "cellDataType": "date", + "pinned": "left" + }, + { + "field": "m1", + "headerName": "M1", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "m2", + "headerName": "M2", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "currency", + "headerName": "Currency", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "demand_deposits", + "headerName": "Demand Deposits", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "retail_money_market_funds", + "headerName": "Retail Money Market Funds", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "other_liquid_deposits", + "headerName": "Other Liquid Deposits", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "small_denomination_time_deposits", + "headerName": "Small Denomination Time Deposits", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReserveMoneyMeasures" + } + }, + "/federal_reserve/treasury_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Government Treasury Rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.treasury_rates(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveTreasuryRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "week_4", + "type": "float | None", + "description": "4 week Treasury bills rate (secondary market).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "month_1", + "type": "float | None", + "description": "1 month Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "month_2", + "type": "float | None", + "description": "2 month Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "month_3", + "type": "float | None", + "description": "3 month Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "month_6", + "type": "float | None", + "description": "6 month Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_1", + "type": "float | None", + "description": "1 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_2", + "type": "float | None", + "description": "2 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_3", + "type": "float | None", + "description": "3 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_5", + "type": "float | None", + "description": "5 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_7", + "type": "float | None", + "description": "7 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_10", + "type": "float | None", + "description": "10 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_20", + "type": "float | None", + "description": "20 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_30", + "type": "float | None", + "description": "30 year Treasury rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "federal_reserve": [] + }, + "model": "FederalReserveTreasuryRates", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Treasury Constant Maturity Rates (H.15)", + "description": "Daily Treasury constant-maturity rates across the curve, in percent, from the Federal Reserve's H.15 release.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left" + }, + { + "field": "month_1", + "headerName": "1 Month", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "month_3", + "headerName": "3 Month", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "month_6", + "headerName": "6 Month", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_1", + "headerName": "1 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_2", + "headerName": "2 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_3", + "headerName": "3 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_5", + "headerName": "5 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_7", + "headerName": "7 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_10", + "headerName": "10 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_20", + "headerName": "20 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + }, + { + "field": "year_30", + "headerName": "30 Year", + "cellDataType": "number", + "formatterFn": "normalizedPercent" + } + ] + } + } + }, + "model": "FederalReserveTreasuryRates" + } + }, + "/federal_reserve/yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get yield curve data by date.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.yield_curve(provider='federal_reserve')\nobb.federal_reserve.yield_curve(date='2024-05-13,2020-05-09', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. By default is the current data. Multiple items allowed for provider(s): federal_reserve.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "federal_reserve": { + "multiple_items_allowed": true + } + } + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveYieldCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [] + }, + "model": "FederalReserveYieldCurve", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FRB", + "name": "Treasury Yield Curve", + "description": "The Treasury constant-maturity yield curve by date, rates in percent across the maturity spectrum.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "chartView": { + "enabled": true, + "chartType": "line" + }, + "columnsDefs": [ + { + "field": "maturity", + "headerName": "Maturity", + "pinned": "left", + "chartDataType": "category" + }, + { + "field": "rate", + "headerName": "Rate", + "cellDataType": "number", + "formatterFn": "normalizedPercent", + "chartDataType": "series" + }, + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "chartDataType": "excluded" + } + ] + } + } + }, + "model": "FederalReserveYieldCurve" + } + }, + "/federal_reserve/ffiec/institutions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the FFIEC National Information Center institution directory.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the FFIEC NIC institution directory by name.\nobb.federal_reserve.ffiec.institutions(name='JPMorgan', provider='federal_reserve')\n# Look up a single institution by RSSD id.\nobb.federal_reserve.ffiec.institutions(rssd_id='1039502', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "name", + "type": "str | None", + "description": "Case-insensitive substring to match against institution names.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "Filter to a specific institution by its RSSD identifier.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ticker", + "type": "str | None", + "description": "Find the parent holding company by its stock ticker.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "Which NIC institution attributes file to search.", + "default": "active", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Active institutions", + "value": "active" + }, + { + "label": "Closed institutions", + "value": "closed" + }, + { + "label": "Branches", + "value": "branches" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveInstitutions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "rssd_id", + "type": "str", + "description": "The institution's RSSD identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "legal_name", + "type": "str | None", + "description": "The legal name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_name", + "type": "str | None", + "description": "The short name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_type_description", + "type": "str | None", + "description": "The human-readable NIC entity type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "charter_type", + "type": "str | None", + "description": "The NIC charter type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "organization_type", + "type": "str | None", + "description": "The legal structure of the organization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_federal_regulator", + "type": "str | None", + "description": "The primary federal regulator of the institution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_bank_holding_company", + "type": "str | None", + "description": "Whether the institution is a bank holding company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_financial_holding_company", + "type": "str | None", + "description": "Whether the institution is a financial holding company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "city", + "type": "str | None", + "description": "The city.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "The state abbreviation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "established_date", + "type": "date | None", + "description": "The date the entity opened or otherwise came into existence.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fdic_cert", + "type": "str | None", + "description": "The FDIC certificate number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "occ_id", + "type": "str | None", + "description": "The OCC charter identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "The Legal Entity Identifier (LEI).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The institution's website.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveInstitutions", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC NIC Institution Search", + "description": "Search the FFIEC National Information Center directory of financial institutions by name, ticker, or RSSD identifier. Click an RSSD to drive the Call Report, UBPR, financial-statement, and structure widgets.", + "gridData": { + "w": 40, + "h": 20 + }, + "runButton": true, + "params": [ + { + "paramName": "rssd_id", + "show": false + } + ], + "data": { + "table": { + "showAll": false, + "columnsDefs": [ + { + "field": "rssd_id", + "headerName": "RSSD ID", + "cellDataType": "text", + "formatterFn": "none", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "rssd_id" + } + } + }, + { + "field": "legal_name", + "headerName": "Legal Name", + "cellDataType": "text" + }, + { + "field": "short_name", + "headerName": "Short Name", + "cellDataType": "text" + }, + { + "field": "entity_type_description", + "headerName": "Entity Type", + "cellDataType": "text" + }, + { + "field": "charter_type", + "headerName": "Charter Type", + "cellDataType": "text" + }, + { + "field": "organization_type", + "headerName": "Organization Type", + "cellDataType": "text" + }, + { + "field": "primary_federal_regulator", + "headerName": "Primary Federal Regulator", + "cellDataType": "text" + }, + { + "field": "is_bank_holding_company", + "headerName": "Bank Holding Company", + "cellDataType": "text" + }, + { + "field": "is_financial_holding_company", + "headerName": "Financial Holding Company", + "cellDataType": "text" + }, + { + "field": "city", + "headerName": "City", + "cellDataType": "text" + }, + { + "field": "state", + "headerName": "State", + "cellDataType": "text" + }, + { + "field": "country", + "headerName": "Country", + "cellDataType": "text" + }, + { + "field": "established_date", + "headerName": "Established Date", + "cellDataType": "date" + }, + { + "field": "fdic_cert", + "headerName": "FDIC Cert", + "cellDataType": "text" + }, + { + "field": "occ_id", + "headerName": "OCC ID", + "cellDataType": "text" + }, + { + "field": "lei", + "headerName": "LEI", + "cellDataType": "text" + }, + { + "field": "url", + "headerName": "URL", + "cellDataType": "text" + } + ] + } + } + }, + "model": "FederalReserveInstitutions" + } + }, + "/federal_reserve/ffiec/call_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a commercial bank's FFIEC Call Report (Consolidated Reports of Condition and Income).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get a bank's latest Call Report by ticker; the symbol resolves to the subsidiary bank, not the parent holding company.\nobb.federal_reserve.ffiec.call_report(symbol='JPM', provider='federal_reserve')\n# Get a bank's latest Call Report by RSSD identifier.\nobb.federal_reserve.ffiec.call_report(rssd_id='852218', provider='federal_reserve')\n# Get just the balance-sheet (instant) items by FDIC certificate.\nobb.federal_reserve.ffiec.call_report(fdic_cert='628', period_type='instant', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "symbol", + "type": "str | None", + "description": "The bank's stock ticker; resolved to the subsidiary bank that files the Call Report (not its parent holding company).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "The bank's RSSD identifier (the Call Report IDRSSD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fdic_cert", + "type": "str | None", + "description": "The bank's FDIC certificate number (alternative to `rssd_id`).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "The reporting period end date; defaults to the latest filed. Call Reports are filed quarterly.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "period_type", + "type": "str | None", + "description": "Limit to 'instant' items (balance-sheet, point-in-time) or 'duration' items (income-statement flows).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveCallReport", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The reporting period end date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str", + "description": "The bank's RSSD identifier (IDRSSD).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The bank's name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "int | None", + "description": "The line item's position in report order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "str | None", + "description": "The Call Report schedule the item appears on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent", + "type": "str | None", + "description": "The parent line item in the report hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level", + "type": "int | None", + "description": "The item's depth in the report hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "The line item caption.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mdrm", + "type": "str", + "description": "The MDRM mnemonic for the concept.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The reported value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measure (e.g. USD thousands, rate).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "decimals", + "type": "int | None", + "description": "The reported precision, as filed in the XBRL.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_type", + "type": "str | None", + "description": "Whether the concept is an instant or a duration.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveCallReport", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC Call Report (Condition & Income)", + "description": "A commercial bank's FFIEC Call Report (Consolidated Reports of Condition and Income) by ticker, RSSD, or FDIC certificate.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left" + }, + { + "field": "rssd_id", + "headerName": "RSSD ID", + "cellDataType": "text", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveCallReport" + } + }, + "/federal_reserve/ffiec/ubpr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a bank's FFIEC Uniform Bank Performance Report (UBPR) measures.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get a bank's UBPR performance measures by ticker; the symbol resolves to the subsidiary bank, not the holding company.\nobb.federal_reserve.ffiec.ubpr(symbol='JPM', provider='federal_reserve')\n# Get a bank's UBPR performance measures by RSSD identifier.\nobb.federal_reserve.ffiec.ubpr(rssd_id='852218', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "symbol", + "type": "str | None", + "description": "The bank's stock ticker, resolved to its parent RSSD identifier.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "The bank's RSSD identifier (the UBPR ID RSSD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "str | None", + "description": "The UBPR report section (page) to return.", + "default": "Summary Ratios", + "optional": true, + "choices": [ + "Summary Ratios", + "Income Statement $", + "QTR Income Statement $", + "Noninterest Income and Expenses", + "Asset Yields and Funding Costs", + "Balance Sheet $", + "Off Balance Sheet Items", + "Derivative Instruments", + "Derivative Analysis", + "Balance Sheet %", + "Allowance & Loan Mix-a", + "Allowance & Loan Mix-b", + "Concentrations of Credit", + "PD, Nonacc & Rest Loans-a", + "PD, Nonacc & Rest Loans-b", + "Interest Rate Risk-a", + "Interest Rate Risk-b", + "Liquidity & Funding", + "Liquidity & Inv Portfolio", + "Capital Analysis-a", + "Capital Analysis-b", + "Capital Analysis-c", + "Income Statement 1-Qtr-Ann", + "Securitization & Asset Sale-a", + "Securitization & Asset Sale-b", + "Securitization & Asset Sale-c", + "Fiduciary Services-a", + "Fiduciary Services-b" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary Ratios", + "value": "Summary Ratios" + }, + { + "label": "Income Statement $", + "value": "Income Statement $" + }, + { + "label": "QTR Income Statement $", + "value": "QTR Income Statement $" + }, + { + "label": "Noninterest Income and Expenses", + "value": "Noninterest Income and Expenses" + }, + { + "label": "Asset Yields and Funding Costs", + "value": "Asset Yields and Funding Costs" + }, + { + "label": "Balance Sheet $", + "value": "Balance Sheet $" + }, + { + "label": "Off Balance Sheet Items", + "value": "Off Balance Sheet Items" + }, + { + "label": "Derivative Instruments", + "value": "Derivative Instruments" + }, + { + "label": "Derivative Analysis", + "value": "Derivative Analysis" + }, + { + "label": "Balance Sheet %", + "value": "Balance Sheet %" + }, + { + "label": "Allowance & Loan Mix-a", + "value": "Allowance & Loan Mix-a" + }, + { + "label": "Allowance & Loan Mix-b", + "value": "Allowance & Loan Mix-b" + }, + { + "label": "Concentrations of Credit", + "value": "Concentrations of Credit" + }, + { + "label": "PD, Nonacc & Rest Loans-a", + "value": "PD, Nonacc & Rest Loans-a" + }, + { + "label": "PD, Nonacc & Rest Loans-b", + "value": "PD, Nonacc & Rest Loans-b" + }, + { + "label": "Interest Rate Risk-a", + "value": "Interest Rate Risk-a" + }, + { + "label": "Interest Rate Risk-b", + "value": "Interest Rate Risk-b" + }, + { + "label": "Liquidity & Funding", + "value": "Liquidity & Funding" + }, + { + "label": "Liquidity & Inv Portfolio", + "value": "Liquidity & Inv Portfolio" + }, + { + "label": "Capital Analysis-a", + "value": "Capital Analysis-a" + }, + { + "label": "Capital Analysis-b", + "value": "Capital Analysis-b" + }, + { + "label": "Capital Analysis-c", + "value": "Capital Analysis-c" + }, + { + "label": "Income Statement 1-Qtr-Ann", + "value": "Income Statement 1-Qtr-Ann" + }, + { + "label": "Securitization & Asset Sale-a", + "value": "Securitization & Asset Sale-a" + }, + { + "label": "Securitization & Asset Sale-b", + "value": "Securitization & Asset Sale-b" + }, + { + "label": "Securitization & Asset Sale-c", + "value": "Securitization & Asset Sale-c" + }, + { + "label": "Fiduciary Services-a", + "value": "Fiduciary Services-a" + }, + { + "label": "Fiduciary Services-b", + "value": "Fiduciary Services-b" + } + ] + } + } + }, + { + "name": "all_periods", + "type": "bool | None", + "description": "Return every reported period as the bank's own time series; the peer-group and percentile columns are omitted.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveUBPR", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The Interactive User's Guide definition of the line item, where one is published.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveUBPR", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC Uniform Bank Performance Report (UBPR)", + "description": "The Uniform Bank Performance Report (UBPR) is an analytical tool created for bank supervisory, examination, and management purposes. In a concise format, it shows the impact of management decisions and economic conditions on a bank's performance and balance-sheet composition. The performance and composition data contained in the report can be used as an aid in evaluating the adequacy of earnings, liquidity, capital, asset and liability management, and growth management. Bankers and examiners alike can use this report to further their understanding of a bank's financial condition, and through such understanding, perform their duties more effectively.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveUBPR" + } + }, + "/federal_reserve/ffiec/executive_summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a bank's FFIEC Executive Summary Report (ESR) measures.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get a bank's Executive Summary Report by ticker; the symbol resolves to the subsidiary bank, not the holding company.\nobb.federal_reserve.ffiec.executive_summary(symbol='JPM', provider='federal_reserve')\n# Get a bank's Executive Summary Report by RSSD identifier.\nobb.federal_reserve.ffiec.executive_summary(rssd_id='451965', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "symbol", + "type": "str | None", + "description": "The bank's stock ticker, resolved to its parent RSSD identifier.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "The bank's RSSD identifier (the UBPR ID RSSD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "all_periods", + "type": "bool | None", + "description": "Return every reported period instead of only the most recent five.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveExecutiveSummary", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The FFIEC Interactive User's Guide definition of the line item's concept, when available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveExecutiveSummary", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC Executive Summary Report (ESR)", + "description": "This report is intended for Bank Executives and Board Members to easily see the trend of an institution's key ratios.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveExecutiveSummary" + } + }, + "/federal_reserve/ffiec/custom_peer_group": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a bank's FFIEC UBPR measures against a custom peer group of RSSDs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get a bank's UBPR measures against a custom peer group of RSSDs, by ticker.\nobb.federal_reserve.ffiec.custom_peer_group(symbol='WFC', peers='451965,480228,852218', provider='federal_reserve')\n# Get a bank's UBPR measures against a custom peer group of RSSDs, by RSSD identifier and report section.\nobb.federal_reserve.ffiec.custom_peer_group(rssd_id='451965', peers='451965,480228,852218', section='Capital Analysis-a', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "symbol", + "type": "str | None", + "description": "The target bank's stock ticker, resolved to its parent RSSD identifier.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "The target bank's RSSD identifier (the UBPR ID RSSD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "peers", + "type": "str | None", + "description": "Comma-separated RSSD identifiers forming the custom peer group; the target bank may be included.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "str | None", + "description": "The UBPR report section (page) to return.", + "default": "Summary Ratios", + "optional": true, + "choices": [ + "Summary Ratios", + "Income Statement $", + "QTR Income Statement $", + "Noninterest Income and Expenses", + "Asset Yields and Funding Costs", + "Balance Sheet $", + "Off Balance Sheet Items", + "Derivative Instruments", + "Derivative Analysis", + "Balance Sheet %", + "Allowance & Loan Mix-a", + "Allowance & Loan Mix-b", + "Concentrations of Credit", + "PD, Nonacc & Rest Loans-a", + "PD, Nonacc & Rest Loans-b", + "Interest Rate Risk-a", + "Interest Rate Risk-b", + "Liquidity & Funding", + "Liquidity & Inv Portfolio", + "Capital Analysis-a", + "Capital Analysis-b", + "Capital Analysis-c", + "Income Statement 1-Qtr-Ann", + "Securitization & Asset Sale-a", + "Securitization & Asset Sale-b", + "Securitization & Asset Sale-c", + "Fiduciary Services-a", + "Fiduciary Services-b" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary Ratios", + "value": "Summary Ratios" + }, + { + "label": "Income Statement $", + "value": "Income Statement $" + }, + { + "label": "QTR Income Statement $", + "value": "QTR Income Statement $" + }, + { + "label": "Noninterest Income and Expenses", + "value": "Noninterest Income and Expenses" + }, + { + "label": "Asset Yields and Funding Costs", + "value": "Asset Yields and Funding Costs" + }, + { + "label": "Balance Sheet $", + "value": "Balance Sheet $" + }, + { + "label": "Off Balance Sheet Items", + "value": "Off Balance Sheet Items" + }, + { + "label": "Derivative Instruments", + "value": "Derivative Instruments" + }, + { + "label": "Derivative Analysis", + "value": "Derivative Analysis" + }, + { + "label": "Balance Sheet %", + "value": "Balance Sheet %" + }, + { + "label": "Allowance & Loan Mix-a", + "value": "Allowance & Loan Mix-a" + }, + { + "label": "Allowance & Loan Mix-b", + "value": "Allowance & Loan Mix-b" + }, + { + "label": "Concentrations of Credit", + "value": "Concentrations of Credit" + }, + { + "label": "PD, Nonacc & Rest Loans-a", + "value": "PD, Nonacc & Rest Loans-a" + }, + { + "label": "PD, Nonacc & Rest Loans-b", + "value": "PD, Nonacc & Rest Loans-b" + }, + { + "label": "Interest Rate Risk-a", + "value": "Interest Rate Risk-a" + }, + { + "label": "Interest Rate Risk-b", + "value": "Interest Rate Risk-b" + }, + { + "label": "Liquidity & Funding", + "value": "Liquidity & Funding" + }, + { + "label": "Liquidity & Inv Portfolio", + "value": "Liquidity & Inv Portfolio" + }, + { + "label": "Capital Analysis-a", + "value": "Capital Analysis-a" + }, + { + "label": "Capital Analysis-b", + "value": "Capital Analysis-b" + }, + { + "label": "Capital Analysis-c", + "value": "Capital Analysis-c" + }, + { + "label": "Income Statement 1-Qtr-Ann", + "value": "Income Statement 1-Qtr-Ann" + }, + { + "label": "Securitization & Asset Sale-a", + "value": "Securitization & Asset Sale-a" + }, + { + "label": "Securitization & Asset Sale-b", + "value": "Securitization & Asset Sale-b" + }, + { + "label": "Securitization & Asset Sale-c", + "value": "Securitization & Asset Sale-c" + }, + { + "label": "Fiduciary Services-a", + "value": "Fiduciary Services-a" + }, + { + "label": "Fiduciary Services-b", + "value": "Fiduciary Services-b" + } + ] + } + } + }, + { + "name": "all_periods", + "type": "bool | None", + "description": "Return every reported period as the bank's own time series.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveCustomPeerGroup", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The MDRM definition of the line item's concept, where available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveCustomPeerGroup", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC UBPR Custom Peer Group (CPG)", + "description": "Similar to the UBPR this report is an analytical tool created for bank supervisory, examination, and management purposes. In a concise format, it shows the impact of management decisions and economic conditions on a bank's performance and balance-sheet composition, evaluated against a user-defined custom peer group.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveCustomPeerGroup" + } + }, + "/federal_reserve/ffiec/peer_group_average": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a UBPR peer group's average performance ratios.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the peer group average UBPR ratios for the largest insured commercial banks (assets greater than $100 billion).\nobb.federal_reserve.ffiec.peer_group_average(peer_group='1', provider='federal_reserve')\n# Get a peer group's average balance-sheet composition.\nobb.federal_reserve.ffiec.peer_group_average(peer_group='4', section='Balance Sheet %', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "peer_group", + "type": "str | None", + "description": "The UBPR peer-group name; the default groups the largest insured commercial banks (assets greater than $100 billion).", + "default": "1", + "optional": true, + "choices": [ + "1", + "101", + "101M", + "101S", + "102", + "102M", + "102S", + "103", + "103M", + "103S", + "104", + "104M", + "104S", + "2", + "201", + "202", + "2022", + "2023", + "2024", + "2025", + "2026", + "203", + "3", + "301", + "4", + "401", + "5", + "6", + "7", + "8", + "AKCOM", + "AKSVG", + "ALCOM", + "ALSVG", + "ARCOM", + "ARSVG", + "AZCOM", + "AZNDT", + "AZSVG", + "BKR", + "CABKR", + "CACOM", + "CANDT", + "CASVG", + "COBKR", + "COCOM", + "COM", + "COSVG", + "CRC", + "CTCOM", + "CTSVG", + "DCCOM", + "DECOM", + "DECRC", + "DENDT", + "DESVG", + "FLCOM", + "FLCRC", + "FLNDT", + "FLSVG", + "FMCOM", + "GACOM", + "GANDT", + "GASVG", + "GUCOM", + "HICOM", + "IACOM", + "IANDT", + "IASVG", + "IDCOM", + "IDSVG", + "ILCOM", + "ILNDT", + "ILSVG", + "INCOM", + "INNDT", + "INSVG", + "KSBKR", + "KSCOM", + "KSSVG", + "KYBKR", + "KYCOM", + "KYSVG", + "LABKR", + "LACOM", + "LASVG", + "MACOM", + "MANDT", + "MASVG", + "MDCOM", + "MDSVG", + "MECOM", + "MESVG", + "MICOM", + "MINDT", + "MISVG", + "MNBKR", + "MNCOM", + "MNNDT", + "MNSVG", + "MOBKR", + "MOCOM", + "MONDT", + "MOSVG", + "MSCOM", + "MSSVG", + "MTCOM", + "MTSVG", + "NATIONAL", + "NCCOM", + "NCNDT", + "NCSVG", + "NDCOM", + "NDSVG", + "NDT", + "NECOM", + "NESVG", + "NHCOM", + "NHSVG", + "NJCOM", + "NJSVG", + "NMCOM", + "NMSVG", + "NVCOM", + "NVCRC", + "NVNDT", + "NVSVG", + "NYCOM", + "NYNDT", + "NYSVG", + "OHCOM", + "OHNDT", + "OHSVG", + "OKBKR", + "OKCOM", + "OKCRC", + "OKNDT", + "OKSVG", + "ORCOM", + "ORNDT", + "ORSVG", + "PABKR", + "PACOM", + "PANDT", + "PASVG", + "PRCOM", + "RICOM", + "RISVG", + "SCCOM", + "SCSVG", + "SDCOM", + "SDNDT", + "SDSVG", + "SVG", + "TNCOM", + "TNSVG", + "TRST301", + "TRST302", + "TRST303", + "TRST304", + "TRST305", + "TXBKR", + "TXCOM", + "TXNDT", + "TXSVG", + "UTCOM", + "UTCRC", + "UTNDT", + "VABKR", + "VACOM", + "VACRC", + "VANDT", + "VASVG", + "VICOM", + "VTCOM", + "VTSVG", + "WACOM", + "WASVG", + "WIBKR", + "WICOM", + "WINDT", + "WISVG", + "WVCOM", + "WVNDT", + "WVSVG", + "WYCOM", + "WYSVG" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "1 -- Insured commercial banks having assets greater than $100 billion", + "value": "1" + }, + { + "label": "101 -- Insured savings banks having assets greater than $1 billion", + "value": "101" + }, + { + "label": "101M -- Mutually-owned insured savings banks having assets greater than $1 billion", + "value": "101M" + }, + { + "label": "101S -- Stock-owned insured savings banks having assets greater than $1 billion", + "value": "101S" + }, + { + "label": "102 -- Insured savings banks having assets between $300 million and $1 billion", + "value": "102" + }, + { + "label": "102M -- Mutually-owned insured savings banks having assets between $300 million and $1 billion", + "value": "102M" + }, + { + "label": "102S -- Stock-owned insured savings banks having assets between $300 million and $1 billion", + "value": "102S" + }, + { + "label": "103 -- Insured savings banks having assets between $100 million and $300 million", + "value": "103" + }, + { + "label": "103M -- Mutually-owned insured savings banks having assets between $100 million and $300 million", + "value": "103M" + }, + { + "label": "103S -- Stock-owned insured savings banks having assets between $100 million and $300 million", + "value": "103S" + }, + { + "label": "104 -- Insured savings banks having assets less than $100 million", + "value": "104" + }, + { + "label": "104M -- Mutually-owned insured savings banks having assets less than $100 million", + "value": "104M" + }, + { + "label": "104S -- Stock-owned insured savings banks having assets less than $100 million", + "value": "104S" + }, + { + "label": "2 -- Insured commercial banks having assets between $10 billion and $100 billion", + "value": "2" + }, + { + "label": "201 -- Credit card specialty banks having assets greater than $ 3 billion", + "value": "201" + }, + { + "label": "202 -- Credit card specialty banks having assets between $1 billion and $3 billion", + "value": "202" + }, + { + "label": "2022 -- Denovo banks opened in 2022 having assets less than $750 million", + "value": "2022" + }, + { + "label": "2023 -- Denovo banks opened in 2023 having assets less than $750 million", + "value": "2023" + }, + { + "label": "2024 -- Denovo banks opened in 2024 having assets less than $750 million", + "value": "2024" + }, + { + "label": "2025 -- Denovo banks opened in 2025 having assets less than $750 million", + "value": "2025" + }, + { + "label": "2026 -- Denovo banks opened in 2026 having assets less than $750 million", + "value": "2026" + }, + { + "label": "203 -- Credit card specialty banks having assets less than $1 billion", + "value": "203" + }, + { + "label": "3 -- Insured commercial banks having assets between $3 billion and $10 billion", + "value": "3" + }, + { + "label": "301 -- Bankers banks", + "value": "301" + }, + { + "label": "4 -- Insured commercial banks having assets between $1 billion and $3 billion", + "value": "4" + }, + { + "label": "401 -- All Non-insured Non-deposit Trust Companies", + "value": "401" + }, + { + "label": "5 -- Insured commercial banks having assets between $300 million and $1 billion", + "value": "5" + }, + { + "label": "6 -- Insured commercial banks having assets between $100 million and $300 million", + "value": "6" + }, + { + "label": "7 -- Insured commercial banks having assets between $50 million and $100 million", + "value": "7" + }, + { + "label": "8 -- Insured commercial banks having assets less than $50 million", + "value": "8" + }, + { + "label": "AKCOM -- All Insured Commercial Banks in Alaska", + "value": "AKCOM" + }, + { + "label": "AKSVG -- All Insured Savings Banks in Alaska", + "value": "AKSVG" + }, + { + "label": "ALCOM -- All Insured Commercial Banks in Alabama", + "value": "ALCOM" + }, + { + "label": "ALSVG -- All Insured Savings Banks in Alabama", + "value": "ALSVG" + }, + { + "label": "ARCOM -- All Insured Commercial Banks in Arkansas", + "value": "ARCOM" + }, + { + "label": "ARSVG -- All Insured Savings Banks in Arkansas", + "value": "ARSVG" + }, + { + "label": "AZCOM -- All Insured Commercial Banks in Arizona", + "value": "AZCOM" + }, + { + "label": "AZNDT -- All Non-insured Non-deposit Trust Companies in Arizona", + "value": "AZNDT" + }, + { + "label": "AZSVG -- All Insured Savings Banks in Arizona", + "value": "AZSVG" + }, + { + "label": "BKR -- Bankers banks", + "value": "BKR" + }, + { + "label": "CABKR -- All Bankers Banks in California", + "value": "CABKR" + }, + { + "label": "CACOM -- All Insured Commercial Banks in California", + "value": "CACOM" + }, + { + "label": "CANDT -- All Non-insured Non-deposit Trust Companies in California", + "value": "CANDT" + }, + { + "label": "CASVG -- All Insured Savings Banks in California", + "value": "CASVG" + }, + { + "label": "COBKR -- All Bankers Banks in Colorado", + "value": "COBKR" + }, + { + "label": "COCOM -- All Insured Commercial Banks in Colorado", + "value": "COCOM" + }, + { + "label": "COM -- All insured commercial banks", + "value": "COM" + }, + { + "label": "COSVG -- All Insured Savings Banks in Colorado", + "value": "COSVG" + }, + { + "label": "CRC -- All credit card specialty banks", + "value": "CRC" + }, + { + "label": "CTCOM -- All Insured Commercial Banks in Connecticut", + "value": "CTCOM" + }, + { + "label": "CTSVG -- All Insured Savings Banks in Connecticut", + "value": "CTSVG" + }, + { + "label": "DCCOM -- All Insured Commercial Banks in District of Columbia", + "value": "DCCOM" + }, + { + "label": "DECOM -- All Insured Commercial Banks in Delaware", + "value": "DECOM" + }, + { + "label": "DECRC -- All Credit Card Specialty Banks in Delaware", + "value": "DECRC" + }, + { + "label": "DENDT -- All Non-insured Non-deposit Trust Companies in Delaware", + "value": "DENDT" + }, + { + "label": "DESVG -- All Insured Savings Banks in Delaware", + "value": "DESVG" + }, + { + "label": "FLCOM -- All Insured Commercial Banks in Florida", + "value": "FLCOM" + }, + { + "label": "FLCRC -- All Credit Card Specialty Banks in Florida", + "value": "FLCRC" + }, + { + "label": "FLNDT -- All Non-insured Non-deposit Trust Companies in Florida", + "value": "FLNDT" + }, + { + "label": "FLSVG -- All Insured Savings Banks in Florida", + "value": "FLSVG" + }, + { + "label": "FMCOM -- All Insured Commercial Banks in Micronesia", + "value": "FMCOM" + }, + { + "label": "GACOM -- All Insured Commercial Banks in Georgia", + "value": "GACOM" + }, + { + "label": "GANDT -- All Non-insured Non-deposit Trust Companies in Georgia", + "value": "GANDT" + }, + { + "label": "GASVG -- All Insured Savings Banks in Georgia", + "value": "GASVG" + }, + { + "label": "GUCOM -- All Insured Commercial Banks in Guam", + "value": "GUCOM" + }, + { + "label": "HICOM -- All Insured Commercial Banks in Hawaii", + "value": "HICOM" + }, + { + "label": "IACOM -- All Insured Commercial Banks in Iowa", + "value": "IACOM" + }, + { + "label": "IANDT -- All Non-insured Non-deposit Trust Companies in Iowa", + "value": "IANDT" + }, + { + "label": "IASVG -- All Insured Savings Banks in Iowa", + "value": "IASVG" + }, + { + "label": "IDCOM -- All Insured Commercial Banks in Idaho", + "value": "IDCOM" + }, + { + "label": "IDSVG -- All Insured Savings Banks in Idaho", + "value": "IDSVG" + }, + { + "label": "ILCOM -- All Insured Commercial Banks in Illinois", + "value": "ILCOM" + }, + { + "label": "ILNDT -- All Non-insured Non-deposit Trust Companies in Illinois", + "value": "ILNDT" + }, + { + "label": "ILSVG -- All Insured Savings Banks in Illinois", + "value": "ILSVG" + }, + { + "label": "INCOM -- All Insured Commercial Banks in Indiana", + "value": "INCOM" + }, + { + "label": "INNDT -- All Non-insured Non-deposit Trust Companies in Indiana", + "value": "INNDT" + }, + { + "label": "INSVG -- All Insured Savings Banks in Indiana", + "value": "INSVG" + }, + { + "label": "KSBKR -- All Bankers Banks in Kansas", + "value": "KSBKR" + }, + { + "label": "KSCOM -- All Insured Commercial Banks in Kansas", + "value": "KSCOM" + }, + { + "label": "KSSVG -- All Insured Savings Banks in Kansas", + "value": "KSSVG" + }, + { + "label": "KYBKR -- All Bankers Banks in Kentucky", + "value": "KYBKR" + }, + { + "label": "KYCOM -- All Insured Commercial Banks in Kentucky", + "value": "KYCOM" + }, + { + "label": "KYSVG -- All Insured Savings Banks in Kentucky", + "value": "KYSVG" + }, + { + "label": "LABKR -- All Bankers Banks in Louisiana", + "value": "LABKR" + }, + { + "label": "LACOM -- All Insured Commercial Banks in Louisiana", + "value": "LACOM" + }, + { + "label": "LASVG -- All Insured Savings Banks in Louisiana", + "value": "LASVG" + }, + { + "label": "MACOM -- All Insured Commercial Banks in Massachusetts", + "value": "MACOM" + }, + { + "label": "MANDT -- All Non-insured Non-deposit Trust Companies in Massachusetts", + "value": "MANDT" + }, + { + "label": "MASVG -- All Insured Savings Banks in Massachusetts", + "value": "MASVG" + }, + { + "label": "MDCOM -- All Insured Commercial Banks in Maryland", + "value": "MDCOM" + }, + { + "label": "MDSVG -- All Insured Savings Banks in Maryland", + "value": "MDSVG" + }, + { + "label": "MECOM -- All Insured Commercial Banks in Maine", + "value": "MECOM" + }, + { + "label": "MESVG -- All Insured Savings Banks in Maine", + "value": "MESVG" + }, + { + "label": "MICOM -- All Insured Commercial Banks in Michigan", + "value": "MICOM" + }, + { + "label": "MINDT -- All Non-insured Non-deposit Trust Companies in Michigan", + "value": "MINDT" + }, + { + "label": "MISVG -- All Insured Savings Banks in Michigan", + "value": "MISVG" + }, + { + "label": "MNBKR -- All Bankers Banks in Minnesota", + "value": "MNBKR" + }, + { + "label": "MNCOM -- All Insured Commercial Banks in Minnesota", + "value": "MNCOM" + }, + { + "label": "MNNDT -- All Non-insured Non-deposit Trust Companies in Minnesota", + "value": "MNNDT" + }, + { + "label": "MNSVG -- All Insured Savings Banks in Minnesota", + "value": "MNSVG" + }, + { + "label": "MOBKR -- All Bankers Banks in Missouri", + "value": "MOBKR" + }, + { + "label": "MOCOM -- All Insured Commercial Banks in Missouri", + "value": "MOCOM" + }, + { + "label": "MONDT -- All Non-insured Non-deposit Trust Companies in Missouri", + "value": "MONDT" + }, + { + "label": "MOSVG -- All Insured Savings Banks in Missouri", + "value": "MOSVG" + }, + { + "label": "MSCOM -- All Insured Commercial Banks in Mississippi", + "value": "MSCOM" + }, + { + "label": "MSSVG -- All Insured Savings Banks in Mississippi", + "value": "MSSVG" + }, + { + "label": "MTCOM -- All Insured Commercial Banks in Montana", + "value": "MTCOM" + }, + { + "label": "MTSVG -- All Insured Savings Banks in Montana", + "value": "MTSVG" + }, + { + "label": "NATIONAL -- All banks in nation", + "value": "NATIONAL" + }, + { + "label": "NCCOM -- All Insured Commercial Banks in North Carolina", + "value": "NCCOM" + }, + { + "label": "NCNDT -- All Non-insured Non-deposit Trust Companies in North Carolina", + "value": "NCNDT" + }, + { + "label": "NCSVG -- All Insured Savings Banks in North Carolina", + "value": "NCSVG" + }, + { + "label": "NDCOM -- All Insured Commercial Banks in North Dakota", + "value": "NDCOM" + }, + { + "label": "NDSVG -- All Insured Savings Banks in North Dakota", + "value": "NDSVG" + }, + { + "label": "NDT -- All Non-insured Non-deposit Trust Companies", + "value": "NDT" + }, + { + "label": "NECOM -- All Insured Commercial Banks in Nebraska", + "value": "NECOM" + }, + { + "label": "NESVG -- All Insured Savings Banks in Nebraska", + "value": "NESVG" + }, + { + "label": "NHCOM -- All Insured Commercial Banks in New Hampshire", + "value": "NHCOM" + }, + { + "label": "NHSVG -- All Insured Savings Banks in New Hampshire", + "value": "NHSVG" + }, + { + "label": "NJCOM -- All Insured Commercial Banks in New Jersey", + "value": "NJCOM" + }, + { + "label": "NJSVG -- All Insured Savings Banks in New Jersey", + "value": "NJSVG" + }, + { + "label": "NMCOM -- All Insured Commercial Banks in New Mexico", + "value": "NMCOM" + }, + { + "label": "NMSVG -- All Insured Savings Banks in New Mexico", + "value": "NMSVG" + }, + { + "label": "NVCOM -- All Insured Commercial Banks in Nevada", + "value": "NVCOM" + }, + { + "label": "NVCRC -- All Credit Card Specialty Banks in Nevada", + "value": "NVCRC" + }, + { + "label": "NVNDT -- All Non-insured Non-deposit Trust Companies in Nevada", + "value": "NVNDT" + }, + { + "label": "NVSVG -- All Insured Savings Banks in Nevada", + "value": "NVSVG" + }, + { + "label": "NYCOM -- All Insured Commercial Banks in New York", + "value": "NYCOM" + }, + { + "label": "NYNDT -- All Non-insured Non-deposit Trust Companies in New York", + "value": "NYNDT" + }, + { + "label": "NYSVG -- All Insured Savings Banks in New York", + "value": "NYSVG" + }, + { + "label": "OHCOM -- All Insured Commercial Banks in Ohio", + "value": "OHCOM" + }, + { + "label": "OHNDT -- All Non-insured Non-deposit Trust Companies in Ohio", + "value": "OHNDT" + }, + { + "label": "OHSVG -- All Insured Savings Banks in Ohio", + "value": "OHSVG" + }, + { + "label": "OKBKR -- All Bankers Banks in Oklahoma", + "value": "OKBKR" + }, + { + "label": "OKCOM -- All Insured Commercial Banks in Oklahoma", + "value": "OKCOM" + }, + { + "label": "OKCRC -- All Credit Card Specialty Banks in Oklahoma", + "value": "OKCRC" + }, + { + "label": "OKNDT -- All Non-insured Non-deposit Trust Companies in Oklahoma", + "value": "OKNDT" + }, + { + "label": "OKSVG -- All Insured Savings Banks in Oklahoma", + "value": "OKSVG" + }, + { + "label": "ORCOM -- All Insured Commercial Banks in Oregon", + "value": "ORCOM" + }, + { + "label": "ORNDT -- All Non-insured Non-deposit Trust Companies in Oregon", + "value": "ORNDT" + }, + { + "label": "ORSVG -- All Insured Savings Banks in Oregon", + "value": "ORSVG" + }, + { + "label": "PABKR -- All Bankers Banks in Pennsylvania", + "value": "PABKR" + }, + { + "label": "PACOM -- All Insured Commercial Banks in Pennsylvania", + "value": "PACOM" + }, + { + "label": "PANDT -- All Non-insured Non-deposit Trust Companies in Pennsylvania", + "value": "PANDT" + }, + { + "label": "PASVG -- All Insured Savings Banks in Pennsylvania", + "value": "PASVG" + }, + { + "label": "PRCOM -- All Insured Commercial Banks in Puerto Rico", + "value": "PRCOM" + }, + { + "label": "RICOM -- All Insured Commercial Banks in Rhode Island", + "value": "RICOM" + }, + { + "label": "RISVG -- All Insured Savings Banks in Rhode Island", + "value": "RISVG" + }, + { + "label": "SCCOM -- All Insured Commercial Banks in South Carolina", + "value": "SCCOM" + }, + { + "label": "SCSVG -- All Insured Savings Banks in South Carolina", + "value": "SCSVG" + }, + { + "label": "SDCOM -- All Insured Commercial Banks in South Dakota", + "value": "SDCOM" + }, + { + "label": "SDNDT -- All Non-insured Non-deposit Trust Companies in South Dakota", + "value": "SDNDT" + }, + { + "label": "SDSVG -- All Insured Savings Banks in South Dakota", + "value": "SDSVG" + }, + { + "label": "SVG -- All insured savings banks", + "value": "SVG" + }, + { + "label": "TNCOM -- All Insured Commercial Banks in Tennessee", + "value": "TNCOM" + }, + { + "label": "TNSVG -- All Insured Savings Banks in Tennessee", + "value": "TNSVG" + }, + { + "label": "TRST301 -- Trust Assets in excess of $100 billion", + "value": "TRST301" + }, + { + "label": "TRST302 -- Trust Assets between $10 billion and $100 billion", + "value": "TRST302" + }, + { + "label": "TRST303 -- Trust Assets between $1 billion and $10 billion", + "value": "TRST303" + }, + { + "label": "TRST304 -- Trust Assets between $250 million and $1 billion", + "value": "TRST304" + }, + { + "label": "TRST305 -- Trust Assets less than $250 million", + "value": "TRST305" + }, + { + "label": "TXBKR -- All Bankers Banks in Texas", + "value": "TXBKR" + }, + { + "label": "TXCOM -- All Insured Commercial Banks in Texas", + "value": "TXCOM" + }, + { + "label": "TXNDT -- All Non-insured Non-deposit Trust Companies in Texas", + "value": "TXNDT" + }, + { + "label": "TXSVG -- All Insured Savings Banks in Texas", + "value": "TXSVG" + }, + { + "label": "UTCOM -- All Insured Commercial Banks in Utah", + "value": "UTCOM" + }, + { + "label": "UTCRC -- All Credit Card Specialty Banks in Utah", + "value": "UTCRC" + }, + { + "label": "UTNDT -- All Non-insured Non-deposit Trust Companies in Utah", + "value": "UTNDT" + }, + { + "label": "VABKR -- All Bankers Banks in Virginia", + "value": "VABKR" + }, + { + "label": "VACOM -- All Insured Commercial Banks in Virginia", + "value": "VACOM" + }, + { + "label": "VACRC -- All Credit Card Specialty Banks in Virginia", + "value": "VACRC" + }, + { + "label": "VANDT -- All Non-insured Non-deposit Trust Companies in Virginia", + "value": "VANDT" + }, + { + "label": "VASVG -- All Insured Savings Banks in Virginia", + "value": "VASVG" + }, + { + "label": "VICOM -- All Insured Commercial Banks in Virgin Islands", + "value": "VICOM" + }, + { + "label": "VTCOM -- All Insured Commercial Banks in Vermont", + "value": "VTCOM" + }, + { + "label": "VTSVG -- All Insured Savings Banks in Vermont", + "value": "VTSVG" + }, + { + "label": "WACOM -- All Insured Commercial Banks in Washington", + "value": "WACOM" + }, + { + "label": "WASVG -- All Insured Savings Banks in Washington", + "value": "WASVG" + }, + { + "label": "WIBKR -- All Bankers Banks in Wisconsin", + "value": "WIBKR" + }, + { + "label": "WICOM -- All Insured Commercial Banks in Wisconsin", + "value": "WICOM" + }, + { + "label": "WINDT -- All Non-insured Non-deposit Trust Companies in Wisconsin", + "value": "WINDT" + }, + { + "label": "WISVG -- All Insured Savings Banks in Wisconsin", + "value": "WISVG" + }, + { + "label": "WVCOM -- All Insured Commercial Banks in West Virginia", + "value": "WVCOM" + }, + { + "label": "WVNDT -- All Non-insured Non-deposit Trust Companies in West Virginia", + "value": "WVNDT" + }, + { + "label": "WVSVG -- All Insured Savings Banks in West Virginia", + "value": "WVSVG" + }, + { + "label": "WYCOM -- All Insured Commercial Banks in Wyoming", + "value": "WYCOM" + }, + { + "label": "WYSVG -- All Insured Savings Banks in Wyoming", + "value": "WYSVG" + } + ] + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "The Peer Group Average Report section (page) to return.", + "default": "Summary Ratios", + "optional": true, + "choices": [ + "Summary Ratios", + "Noninterest Income and Expenses", + "Asset Yields and Funding Costs", + "Off Balance Sheet Items", + "Derivative Analysis", + "Balance Sheet %", + "Allowance & Loan Mix-a", + "Allowance & Loan Mix-b", + "Concentrations of Credit", + "PD, Nonacc & Rest Loans-a", + "PD, Nonacc & Rest Loans-b", + "Interest Rate Risk-a", + "Interest Rate Risk-b", + "Liquidity & Funding", + "Liquidity & Inv Portfolio", + "Capital Analysis-a", + "Income Statement 1-Qtr-Ann", + "Fiduciary Services-a" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary Ratios", + "value": "Summary Ratios" + }, + { + "label": "Noninterest Income and Expenses", + "value": "Noninterest Income and Expenses" + }, + { + "label": "Asset Yields and Funding Costs", + "value": "Asset Yields and Funding Costs" + }, + { + "label": "Off Balance Sheet Items", + "value": "Off Balance Sheet Items" + }, + { + "label": "Derivative Analysis", + "value": "Derivative Analysis" + }, + { + "label": "Balance Sheet %", + "value": "Balance Sheet %" + }, + { + "label": "Allowance & Loan Mix-a", + "value": "Allowance & Loan Mix-a" + }, + { + "label": "Allowance & Loan Mix-b", + "value": "Allowance & Loan Mix-b" + }, + { + "label": "Concentrations of Credit", + "value": "Concentrations of Credit" + }, + { + "label": "PD, Nonacc & Rest Loans-a", + "value": "PD, Nonacc & Rest Loans-a" + }, + { + "label": "PD, Nonacc & Rest Loans-b", + "value": "PD, Nonacc & Rest Loans-b" + }, + { + "label": "Interest Rate Risk-a", + "value": "Interest Rate Risk-a" + }, + { + "label": "Interest Rate Risk-b", + "value": "Interest Rate Risk-b" + }, + { + "label": "Liquidity & Funding", + "value": "Liquidity & Funding" + }, + { + "label": "Liquidity & Inv Portfolio", + "value": "Liquidity & Inv Portfolio" + }, + { + "label": "Capital Analysis-a", + "value": "Capital Analysis-a" + }, + { + "label": "Income Statement 1-Qtr-Ann", + "value": "Income Statement 1-Qtr-Ann" + }, + { + "label": "Fiduciary Services-a", + "value": "Fiduciary Services-a" + } + ] + } + } + }, + { + "name": "all_periods", + "type": "bool | None", + "description": "Return every reported period instead of only the most recent five.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePeerGroupAverage", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The MDRM definition of the line item, when available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePeerGroupAverage", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC UBPR Peer Group Average Report", + "description": "This report displays all UBPR ratios averaged by peer group in UBPR format. All peer groups are available.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReservePeerGroupAverage" + } + }, + "/federal_reserve/ffiec/peer_group_bank": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FFIEC UBPR Peer Group Bank Report for a bank's peer group.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the UBPR Peer Group Bank Report for a bank by ticker; the symbol resolves to the subsidiary bank, whose UBPR peer group defines the set of banks compared.\nobb.federal_reserve.ffiec.peer_group_bank(symbol='WFC', provider='federal_reserve')\n# Get the UBPR Peer Group Bank Report by RSSD identifier.\nobb.federal_reserve.ffiec.peer_group_bank(rssd_id='451965', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "symbol", + "type": "str | None", + "description": "The bank's stock ticker, resolved to its parent RSSD identifier.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "The bank's RSSD identifier; its UBPR peer group drives the report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "str | None", + "description": "The UBPR report section (page) to return.", + "default": "Summary Ratios", + "optional": true, + "choices": [ + "Summary Ratios", + "Income Statement $", + "QTR Income Statement $", + "Noninterest Income and Expenses", + "Asset Yields and Funding Costs", + "Balance Sheet $", + "Off Balance Sheet Items", + "Derivative Instruments", + "Derivative Analysis", + "Balance Sheet %", + "Allowance & Loan Mix-a", + "Allowance & Loan Mix-b", + "Concentrations of Credit", + "PD, Nonacc & Rest Loans-a", + "PD, Nonacc & Rest Loans-b", + "Interest Rate Risk-a", + "Interest Rate Risk-b", + "Liquidity & Funding", + "Liquidity & Inv Portfolio", + "Capital Analysis-a", + "Capital Analysis-b", + "Capital Analysis-c", + "Income Statement 1-Qtr-Ann", + "Securitization & Asset Sale-a", + "Securitization & Asset Sale-b", + "Securitization & Asset Sale-c", + "Fiduciary Services-a", + "Fiduciary Services-b" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary Ratios", + "value": "Summary Ratios" + }, + { + "label": "Income Statement $", + "value": "Income Statement $" + }, + { + "label": "QTR Income Statement $", + "value": "QTR Income Statement $" + }, + { + "label": "Noninterest Income and Expenses", + "value": "Noninterest Income and Expenses" + }, + { + "label": "Asset Yields and Funding Costs", + "value": "Asset Yields and Funding Costs" + }, + { + "label": "Balance Sheet $", + "value": "Balance Sheet $" + }, + { + "label": "Off Balance Sheet Items", + "value": "Off Balance Sheet Items" + }, + { + "label": "Derivative Instruments", + "value": "Derivative Instruments" + }, + { + "label": "Derivative Analysis", + "value": "Derivative Analysis" + }, + { + "label": "Balance Sheet %", + "value": "Balance Sheet %" + }, + { + "label": "Allowance & Loan Mix-a", + "value": "Allowance & Loan Mix-a" + }, + { + "label": "Allowance & Loan Mix-b", + "value": "Allowance & Loan Mix-b" + }, + { + "label": "Concentrations of Credit", + "value": "Concentrations of Credit" + }, + { + "label": "PD, Nonacc & Rest Loans-a", + "value": "PD, Nonacc & Rest Loans-a" + }, + { + "label": "PD, Nonacc & Rest Loans-b", + "value": "PD, Nonacc & Rest Loans-b" + }, + { + "label": "Interest Rate Risk-a", + "value": "Interest Rate Risk-a" + }, + { + "label": "Interest Rate Risk-b", + "value": "Interest Rate Risk-b" + }, + { + "label": "Liquidity & Funding", + "value": "Liquidity & Funding" + }, + { + "label": "Liquidity & Inv Portfolio", + "value": "Liquidity & Inv Portfolio" + }, + { + "label": "Capital Analysis-a", + "value": "Capital Analysis-a" + }, + { + "label": "Capital Analysis-b", + "value": "Capital Analysis-b" + }, + { + "label": "Capital Analysis-c", + "value": "Capital Analysis-c" + }, + { + "label": "Income Statement 1-Qtr-Ann", + "value": "Income Statement 1-Qtr-Ann" + }, + { + "label": "Securitization & Asset Sale-a", + "value": "Securitization & Asset Sale-a" + }, + { + "label": "Securitization & Asset Sale-b", + "value": "Securitization & Asset Sale-b" + }, + { + "label": "Securitization & Asset Sale-c", + "value": "Securitization & Asset Sale-c" + }, + { + "label": "Fiduciary Services-a", + "value": "Fiduciary Services-a" + }, + { + "label": "Fiduciary Services-b", + "value": "Fiduciary Services-b" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePeerGroupBank", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The UBPR User's Guide definition of the line item, shown in a hover card.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePeerGroupBank", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC UBPR Peer Group Bank Report", + "description": "Displays the Uniform Bank Performance Report (UBPR) for every bank in a peer group side by side, so a bank's section line items can be compared directly against its peers for the latest reporting period.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReservePeerGroupBank" + } + }, + "/federal_reserve/ffiec/peer_group_distribution": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FFIEC UBPR Peer Group Average Distribution for a peer group.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the percentile distribution of Summary Ratios across UBPR commercial-bank peer group 1.\nobb.federal_reserve.ffiec.peer_group_distribution(peer_group='1', provider='federal_reserve')\n# Get the Capital Analysis distribution for all insured commercial banks at a specific quarter.\nobb.federal_reserve.ffiec.peer_group_distribution(peer_group='NATIONAL', section='Capital Analysis-a', period='2025-12-31', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "peer_group", + "type": "str | None", + "description": "The UBPR peer-group name (e.g. '1', 'NATIONAL', 'ALCOM').", + "default": "1", + "optional": true, + "choices": [ + "1", + "101", + "101M", + "101S", + "102", + "102M", + "102S", + "103", + "103M", + "103S", + "104", + "104M", + "104S", + "2", + "201", + "202", + "2022", + "2023", + "2024", + "2025", + "2026", + "203", + "3", + "301", + "4", + "401", + "5", + "6", + "7", + "8", + "AKCOM", + "AKSVG", + "ALCOM", + "ALSVG", + "ARCOM", + "ARSVG", + "AZCOM", + "AZNDT", + "AZSVG", + "BKR", + "CABKR", + "CACOM", + "CANDT", + "CASVG", + "COBKR", + "COCOM", + "COM", + "COSVG", + "CRC", + "CTCOM", + "CTSVG", + "DCCOM", + "DECOM", + "DECRC", + "DENDT", + "DESVG", + "FLCOM", + "FLCRC", + "FLNDT", + "FLSVG", + "FMCOM", + "GACOM", + "GANDT", + "GASVG", + "GUCOM", + "HICOM", + "IACOM", + "IANDT", + "IASVG", + "IDCOM", + "IDSVG", + "ILCOM", + "ILNDT", + "ILSVG", + "INCOM", + "INNDT", + "INSVG", + "KSBKR", + "KSCOM", + "KSSVG", + "KYBKR", + "KYCOM", + "KYSVG", + "LABKR", + "LACOM", + "LASVG", + "MACOM", + "MANDT", + "MASVG", + "MDCOM", + "MDSVG", + "MECOM", + "MESVG", + "MICOM", + "MINDT", + "MISVG", + "MNBKR", + "MNCOM", + "MNNDT", + "MNSVG", + "MOBKR", + "MOCOM", + "MONDT", + "MOSVG", + "MSCOM", + "MSSVG", + "MTCOM", + "MTSVG", + "NATIONAL", + "NCCOM", + "NCNDT", + "NCSVG", + "NDCOM", + "NDSVG", + "NDT", + "NECOM", + "NESVG", + "NHCOM", + "NHSVG", + "NJCOM", + "NJSVG", + "NMCOM", + "NMSVG", + "NVCOM", + "NVCRC", + "NVNDT", + "NVSVG", + "NYCOM", + "NYNDT", + "NYSVG", + "OHCOM", + "OHNDT", + "OHSVG", + "OKBKR", + "OKCOM", + "OKCRC", + "OKNDT", + "OKSVG", + "ORCOM", + "ORNDT", + "ORSVG", + "PABKR", + "PACOM", + "PANDT", + "PASVG", + "PRCOM", + "RICOM", + "RISVG", + "SCCOM", + "SCSVG", + "SDCOM", + "SDNDT", + "SDSVG", + "SVG", + "TNCOM", + "TNSVG", + "TRST301", + "TRST302", + "TRST303", + "TRST304", + "TRST305", + "TXBKR", + "TXCOM", + "TXNDT", + "TXSVG", + "UTCOM", + "UTCRC", + "UTNDT", + "VABKR", + "VACOM", + "VACRC", + "VANDT", + "VASVG", + "VICOM", + "VTCOM", + "VTSVG", + "WACOM", + "WASVG", + "WIBKR", + "WICOM", + "WINDT", + "WISVG", + "WVCOM", + "WVNDT", + "WVSVG", + "WYCOM", + "WYSVG" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "1 -- Insured commercial banks having assets greater than $100 billion", + "value": "1" + }, + { + "label": "101 -- Insured savings banks having assets greater than $1 billion", + "value": "101" + }, + { + "label": "101M -- Mutually-owned insured savings banks having assets greater than $1 billion", + "value": "101M" + }, + { + "label": "101S -- Stock-owned insured savings banks having assets greater than $1 billion", + "value": "101S" + }, + { + "label": "102 -- Insured savings banks having assets between $300 million and $1 billion", + "value": "102" + }, + { + "label": "102M -- Mutually-owned insured savings banks having assets between $300 million and $1 billion", + "value": "102M" + }, + { + "label": "102S -- Stock-owned insured savings banks having assets between $300 million and $1 billion", + "value": "102S" + }, + { + "label": "103 -- Insured savings banks having assets between $100 million and $300 million", + "value": "103" + }, + { + "label": "103M -- Mutually-owned insured savings banks having assets between $100 million and $300 million", + "value": "103M" + }, + { + "label": "103S -- Stock-owned insured savings banks having assets between $100 million and $300 million", + "value": "103S" + }, + { + "label": "104 -- Insured savings banks having assets less than $100 million", + "value": "104" + }, + { + "label": "104M -- Mutually-owned insured savings banks having assets less than $100 million", + "value": "104M" + }, + { + "label": "104S -- Stock-owned insured savings banks having assets less than $100 million", + "value": "104S" + }, + { + "label": "2 -- Insured commercial banks having assets between $10 billion and $100 billion", + "value": "2" + }, + { + "label": "201 -- Credit card specialty banks having assets greater than $ 3 billion", + "value": "201" + }, + { + "label": "202 -- Credit card specialty banks having assets between $1 billion and $3 billion", + "value": "202" + }, + { + "label": "2022 -- Denovo banks opened in 2022 having assets less than $750 million", + "value": "2022" + }, + { + "label": "2023 -- Denovo banks opened in 2023 having assets less than $750 million", + "value": "2023" + }, + { + "label": "2024 -- Denovo banks opened in 2024 having assets less than $750 million", + "value": "2024" + }, + { + "label": "2025 -- Denovo banks opened in 2025 having assets less than $750 million", + "value": "2025" + }, + { + "label": "2026 -- Denovo banks opened in 2026 having assets less than $750 million", + "value": "2026" + }, + { + "label": "203 -- Credit card specialty banks having assets less than $1 billion", + "value": "203" + }, + { + "label": "3 -- Insured commercial banks having assets between $3 billion and $10 billion", + "value": "3" + }, + { + "label": "301 -- Bankers banks", + "value": "301" + }, + { + "label": "4 -- Insured commercial banks having assets between $1 billion and $3 billion", + "value": "4" + }, + { + "label": "401 -- All Non-insured Non-deposit Trust Companies", + "value": "401" + }, + { + "label": "5 -- Insured commercial banks having assets between $300 million and $1 billion", + "value": "5" + }, + { + "label": "6 -- Insured commercial banks having assets between $100 million and $300 million", + "value": "6" + }, + { + "label": "7 -- Insured commercial banks having assets between $50 million and $100 million", + "value": "7" + }, + { + "label": "8 -- Insured commercial banks having assets less than $50 million", + "value": "8" + }, + { + "label": "AKCOM -- All Insured Commercial Banks in Alaska", + "value": "AKCOM" + }, + { + "label": "AKSVG -- All Insured Savings Banks in Alaska", + "value": "AKSVG" + }, + { + "label": "ALCOM -- All Insured Commercial Banks in Alabama", + "value": "ALCOM" + }, + { + "label": "ALSVG -- All Insured Savings Banks in Alabama", + "value": "ALSVG" + }, + { + "label": "ARCOM -- All Insured Commercial Banks in Arkansas", + "value": "ARCOM" + }, + { + "label": "ARSVG -- All Insured Savings Banks in Arkansas", + "value": "ARSVG" + }, + { + "label": "AZCOM -- All Insured Commercial Banks in Arizona", + "value": "AZCOM" + }, + { + "label": "AZNDT -- All Non-insured Non-deposit Trust Companies in Arizona", + "value": "AZNDT" + }, + { + "label": "AZSVG -- All Insured Savings Banks in Arizona", + "value": "AZSVG" + }, + { + "label": "BKR -- Bankers banks", + "value": "BKR" + }, + { + "label": "CABKR -- All Bankers Banks in California", + "value": "CABKR" + }, + { + "label": "CACOM -- All Insured Commercial Banks in California", + "value": "CACOM" + }, + { + "label": "CANDT -- All Non-insured Non-deposit Trust Companies in California", + "value": "CANDT" + }, + { + "label": "CASVG -- All Insured Savings Banks in California", + "value": "CASVG" + }, + { + "label": "COBKR -- All Bankers Banks in Colorado", + "value": "COBKR" + }, + { + "label": "COCOM -- All Insured Commercial Banks in Colorado", + "value": "COCOM" + }, + { + "label": "COM -- All insured commercial banks", + "value": "COM" + }, + { + "label": "COSVG -- All Insured Savings Banks in Colorado", + "value": "COSVG" + }, + { + "label": "CRC -- All credit card specialty banks", + "value": "CRC" + }, + { + "label": "CTCOM -- All Insured Commercial Banks in Connecticut", + "value": "CTCOM" + }, + { + "label": "CTSVG -- All Insured Savings Banks in Connecticut", + "value": "CTSVG" + }, + { + "label": "DCCOM -- All Insured Commercial Banks in District of Columbia", + "value": "DCCOM" + }, + { + "label": "DECOM -- All Insured Commercial Banks in Delaware", + "value": "DECOM" + }, + { + "label": "DECRC -- All Credit Card Specialty Banks in Delaware", + "value": "DECRC" + }, + { + "label": "DENDT -- All Non-insured Non-deposit Trust Companies in Delaware", + "value": "DENDT" + }, + { + "label": "DESVG -- All Insured Savings Banks in Delaware", + "value": "DESVG" + }, + { + "label": "FLCOM -- All Insured Commercial Banks in Florida", + "value": "FLCOM" + }, + { + "label": "FLCRC -- All Credit Card Specialty Banks in Florida", + "value": "FLCRC" + }, + { + "label": "FLNDT -- All Non-insured Non-deposit Trust Companies in Florida", + "value": "FLNDT" + }, + { + "label": "FLSVG -- All Insured Savings Banks in Florida", + "value": "FLSVG" + }, + { + "label": "FMCOM -- All Insured Commercial Banks in Micronesia", + "value": "FMCOM" + }, + { + "label": "GACOM -- All Insured Commercial Banks in Georgia", + "value": "GACOM" + }, + { + "label": "GANDT -- All Non-insured Non-deposit Trust Companies in Georgia", + "value": "GANDT" + }, + { + "label": "GASVG -- All Insured Savings Banks in Georgia", + "value": "GASVG" + }, + { + "label": "GUCOM -- All Insured Commercial Banks in Guam", + "value": "GUCOM" + }, + { + "label": "HICOM -- All Insured Commercial Banks in Hawaii", + "value": "HICOM" + }, + { + "label": "IACOM -- All Insured Commercial Banks in Iowa", + "value": "IACOM" + }, + { + "label": "IANDT -- All Non-insured Non-deposit Trust Companies in Iowa", + "value": "IANDT" + }, + { + "label": "IASVG -- All Insured Savings Banks in Iowa", + "value": "IASVG" + }, + { + "label": "IDCOM -- All Insured Commercial Banks in Idaho", + "value": "IDCOM" + }, + { + "label": "IDSVG -- All Insured Savings Banks in Idaho", + "value": "IDSVG" + }, + { + "label": "ILCOM -- All Insured Commercial Banks in Illinois", + "value": "ILCOM" + }, + { + "label": "ILNDT -- All Non-insured Non-deposit Trust Companies in Illinois", + "value": "ILNDT" + }, + { + "label": "ILSVG -- All Insured Savings Banks in Illinois", + "value": "ILSVG" + }, + { + "label": "INCOM -- All Insured Commercial Banks in Indiana", + "value": "INCOM" + }, + { + "label": "INNDT -- All Non-insured Non-deposit Trust Companies in Indiana", + "value": "INNDT" + }, + { + "label": "INSVG -- All Insured Savings Banks in Indiana", + "value": "INSVG" + }, + { + "label": "KSBKR -- All Bankers Banks in Kansas", + "value": "KSBKR" + }, + { + "label": "KSCOM -- All Insured Commercial Banks in Kansas", + "value": "KSCOM" + }, + { + "label": "KSSVG -- All Insured Savings Banks in Kansas", + "value": "KSSVG" + }, + { + "label": "KYBKR -- All Bankers Banks in Kentucky", + "value": "KYBKR" + }, + { + "label": "KYCOM -- All Insured Commercial Banks in Kentucky", + "value": "KYCOM" + }, + { + "label": "KYSVG -- All Insured Savings Banks in Kentucky", + "value": "KYSVG" + }, + { + "label": "LABKR -- All Bankers Banks in Louisiana", + "value": "LABKR" + }, + { + "label": "LACOM -- All Insured Commercial Banks in Louisiana", + "value": "LACOM" + }, + { + "label": "LASVG -- All Insured Savings Banks in Louisiana", + "value": "LASVG" + }, + { + "label": "MACOM -- All Insured Commercial Banks in Massachusetts", + "value": "MACOM" + }, + { + "label": "MANDT -- All Non-insured Non-deposit Trust Companies in Massachusetts", + "value": "MANDT" + }, + { + "label": "MASVG -- All Insured Savings Banks in Massachusetts", + "value": "MASVG" + }, + { + "label": "MDCOM -- All Insured Commercial Banks in Maryland", + "value": "MDCOM" + }, + { + "label": "MDSVG -- All Insured Savings Banks in Maryland", + "value": "MDSVG" + }, + { + "label": "MECOM -- All Insured Commercial Banks in Maine", + "value": "MECOM" + }, + { + "label": "MESVG -- All Insured Savings Banks in Maine", + "value": "MESVG" + }, + { + "label": "MICOM -- All Insured Commercial Banks in Michigan", + "value": "MICOM" + }, + { + "label": "MINDT -- All Non-insured Non-deposit Trust Companies in Michigan", + "value": "MINDT" + }, + { + "label": "MISVG -- All Insured Savings Banks in Michigan", + "value": "MISVG" + }, + { + "label": "MNBKR -- All Bankers Banks in Minnesota", + "value": "MNBKR" + }, + { + "label": "MNCOM -- All Insured Commercial Banks in Minnesota", + "value": "MNCOM" + }, + { + "label": "MNNDT -- All Non-insured Non-deposit Trust Companies in Minnesota", + "value": "MNNDT" + }, + { + "label": "MNSVG -- All Insured Savings Banks in Minnesota", + "value": "MNSVG" + }, + { + "label": "MOBKR -- All Bankers Banks in Missouri", + "value": "MOBKR" + }, + { + "label": "MOCOM -- All Insured Commercial Banks in Missouri", + "value": "MOCOM" + }, + { + "label": "MONDT -- All Non-insured Non-deposit Trust Companies in Missouri", + "value": "MONDT" + }, + { + "label": "MOSVG -- All Insured Savings Banks in Missouri", + "value": "MOSVG" + }, + { + "label": "MSCOM -- All Insured Commercial Banks in Mississippi", + "value": "MSCOM" + }, + { + "label": "MSSVG -- All Insured Savings Banks in Mississippi", + "value": "MSSVG" + }, + { + "label": "MTCOM -- All Insured Commercial Banks in Montana", + "value": "MTCOM" + }, + { + "label": "MTSVG -- All Insured Savings Banks in Montana", + "value": "MTSVG" + }, + { + "label": "NATIONAL -- All banks in nation", + "value": "NATIONAL" + }, + { + "label": "NCCOM -- All Insured Commercial Banks in North Carolina", + "value": "NCCOM" + }, + { + "label": "NCNDT -- All Non-insured Non-deposit Trust Companies in North Carolina", + "value": "NCNDT" + }, + { + "label": "NCSVG -- All Insured Savings Banks in North Carolina", + "value": "NCSVG" + }, + { + "label": "NDCOM -- All Insured Commercial Banks in North Dakota", + "value": "NDCOM" + }, + { + "label": "NDSVG -- All Insured Savings Banks in North Dakota", + "value": "NDSVG" + }, + { + "label": "NDT -- All Non-insured Non-deposit Trust Companies", + "value": "NDT" + }, + { + "label": "NECOM -- All Insured Commercial Banks in Nebraska", + "value": "NECOM" + }, + { + "label": "NESVG -- All Insured Savings Banks in Nebraska", + "value": "NESVG" + }, + { + "label": "NHCOM -- All Insured Commercial Banks in New Hampshire", + "value": "NHCOM" + }, + { + "label": "NHSVG -- All Insured Savings Banks in New Hampshire", + "value": "NHSVG" + }, + { + "label": "NJCOM -- All Insured Commercial Banks in New Jersey", + "value": "NJCOM" + }, + { + "label": "NJSVG -- All Insured Savings Banks in New Jersey", + "value": "NJSVG" + }, + { + "label": "NMCOM -- All Insured Commercial Banks in New Mexico", + "value": "NMCOM" + }, + { + "label": "NMSVG -- All Insured Savings Banks in New Mexico", + "value": "NMSVG" + }, + { + "label": "NVCOM -- All Insured Commercial Banks in Nevada", + "value": "NVCOM" + }, + { + "label": "NVCRC -- All Credit Card Specialty Banks in Nevada", + "value": "NVCRC" + }, + { + "label": "NVNDT -- All Non-insured Non-deposit Trust Companies in Nevada", + "value": "NVNDT" + }, + { + "label": "NVSVG -- All Insured Savings Banks in Nevada", + "value": "NVSVG" + }, + { + "label": "NYCOM -- All Insured Commercial Banks in New York", + "value": "NYCOM" + }, + { + "label": "NYNDT -- All Non-insured Non-deposit Trust Companies in New York", + "value": "NYNDT" + }, + { + "label": "NYSVG -- All Insured Savings Banks in New York", + "value": "NYSVG" + }, + { + "label": "OHCOM -- All Insured Commercial Banks in Ohio", + "value": "OHCOM" + }, + { + "label": "OHNDT -- All Non-insured Non-deposit Trust Companies in Ohio", + "value": "OHNDT" + }, + { + "label": "OHSVG -- All Insured Savings Banks in Ohio", + "value": "OHSVG" + }, + { + "label": "OKBKR -- All Bankers Banks in Oklahoma", + "value": "OKBKR" + }, + { + "label": "OKCOM -- All Insured Commercial Banks in Oklahoma", + "value": "OKCOM" + }, + { + "label": "OKCRC -- All Credit Card Specialty Banks in Oklahoma", + "value": "OKCRC" + }, + { + "label": "OKNDT -- All Non-insured Non-deposit Trust Companies in Oklahoma", + "value": "OKNDT" + }, + { + "label": "OKSVG -- All Insured Savings Banks in Oklahoma", + "value": "OKSVG" + }, + { + "label": "ORCOM -- All Insured Commercial Banks in Oregon", + "value": "ORCOM" + }, + { + "label": "ORNDT -- All Non-insured Non-deposit Trust Companies in Oregon", + "value": "ORNDT" + }, + { + "label": "ORSVG -- All Insured Savings Banks in Oregon", + "value": "ORSVG" + }, + { + "label": "PABKR -- All Bankers Banks in Pennsylvania", + "value": "PABKR" + }, + { + "label": "PACOM -- All Insured Commercial Banks in Pennsylvania", + "value": "PACOM" + }, + { + "label": "PANDT -- All Non-insured Non-deposit Trust Companies in Pennsylvania", + "value": "PANDT" + }, + { + "label": "PASVG -- All Insured Savings Banks in Pennsylvania", + "value": "PASVG" + }, + { + "label": "PRCOM -- All Insured Commercial Banks in Puerto Rico", + "value": "PRCOM" + }, + { + "label": "RICOM -- All Insured Commercial Banks in Rhode Island", + "value": "RICOM" + }, + { + "label": "RISVG -- All Insured Savings Banks in Rhode Island", + "value": "RISVG" + }, + { + "label": "SCCOM -- All Insured Commercial Banks in South Carolina", + "value": "SCCOM" + }, + { + "label": "SCSVG -- All Insured Savings Banks in South Carolina", + "value": "SCSVG" + }, + { + "label": "SDCOM -- All Insured Commercial Banks in South Dakota", + "value": "SDCOM" + }, + { + "label": "SDNDT -- All Non-insured Non-deposit Trust Companies in South Dakota", + "value": "SDNDT" + }, + { + "label": "SDSVG -- All Insured Savings Banks in South Dakota", + "value": "SDSVG" + }, + { + "label": "SVG -- All insured savings banks", + "value": "SVG" + }, + { + "label": "TNCOM -- All Insured Commercial Banks in Tennessee", + "value": "TNCOM" + }, + { + "label": "TNSVG -- All Insured Savings Banks in Tennessee", + "value": "TNSVG" + }, + { + "label": "TRST301 -- Trust Assets in excess of $100 billion", + "value": "TRST301" + }, + { + "label": "TRST302 -- Trust Assets between $10 billion and $100 billion", + "value": "TRST302" + }, + { + "label": "TRST303 -- Trust Assets between $1 billion and $10 billion", + "value": "TRST303" + }, + { + "label": "TRST304 -- Trust Assets between $250 million and $1 billion", + "value": "TRST304" + }, + { + "label": "TRST305 -- Trust Assets less than $250 million", + "value": "TRST305" + }, + { + "label": "TXBKR -- All Bankers Banks in Texas", + "value": "TXBKR" + }, + { + "label": "TXCOM -- All Insured Commercial Banks in Texas", + "value": "TXCOM" + }, + { + "label": "TXNDT -- All Non-insured Non-deposit Trust Companies in Texas", + "value": "TXNDT" + }, + { + "label": "TXSVG -- All Insured Savings Banks in Texas", + "value": "TXSVG" + }, + { + "label": "UTCOM -- All Insured Commercial Banks in Utah", + "value": "UTCOM" + }, + { + "label": "UTCRC -- All Credit Card Specialty Banks in Utah", + "value": "UTCRC" + }, + { + "label": "UTNDT -- All Non-insured Non-deposit Trust Companies in Utah", + "value": "UTNDT" + }, + { + "label": "VABKR -- All Bankers Banks in Virginia", + "value": "VABKR" + }, + { + "label": "VACOM -- All Insured Commercial Banks in Virginia", + "value": "VACOM" + }, + { + "label": "VACRC -- All Credit Card Specialty Banks in Virginia", + "value": "VACRC" + }, + { + "label": "VANDT -- All Non-insured Non-deposit Trust Companies in Virginia", + "value": "VANDT" + }, + { + "label": "VASVG -- All Insured Savings Banks in Virginia", + "value": "VASVG" + }, + { + "label": "VICOM -- All Insured Commercial Banks in Virgin Islands", + "value": "VICOM" + }, + { + "label": "VTCOM -- All Insured Commercial Banks in Vermont", + "value": "VTCOM" + }, + { + "label": "VTSVG -- All Insured Savings Banks in Vermont", + "value": "VTSVG" + }, + { + "label": "WACOM -- All Insured Commercial Banks in Washington", + "value": "WACOM" + }, + { + "label": "WASVG -- All Insured Savings Banks in Washington", + "value": "WASVG" + }, + { + "label": "WIBKR -- All Bankers Banks in Wisconsin", + "value": "WIBKR" + }, + { + "label": "WICOM -- All Insured Commercial Banks in Wisconsin", + "value": "WICOM" + }, + { + "label": "WINDT -- All Non-insured Non-deposit Trust Companies in Wisconsin", + "value": "WINDT" + }, + { + "label": "WISVG -- All Insured Savings Banks in Wisconsin", + "value": "WISVG" + }, + { + "label": "WVCOM -- All Insured Commercial Banks in West Virginia", + "value": "WVCOM" + }, + { + "label": "WVNDT -- All Non-insured Non-deposit Trust Companies in West Virginia", + "value": "WVNDT" + }, + { + "label": "WVSVG -- All Insured Savings Banks in West Virginia", + "value": "WVSVG" + }, + { + "label": "WYCOM -- All Insured Commercial Banks in Wyoming", + "value": "WYCOM" + }, + { + "label": "WYSVG -- All Insured Savings Banks in Wyoming", + "value": "WYSVG" + } + ] + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "The report page (section) to return.", + "default": "Summary Ratios", + "optional": true, + "choices": [ + "Summary Ratios", + "Noninterest Income and Expenses", + "Asset Yields and Funding Costs", + "Off Balance Sheet Items", + "Derivative Analysis", + "Balance Sheet %", + "Allowance & Loan Mix-a", + "Allowance & Loan Mix-b", + "Concentrations of Credit", + "PD, Nonacc & Rest Loans-a", + "PD, Nonacc & Rest Loans-b", + "Interest Rate Risk-a", + "Interest Rate Risk-b", + "Liquidity & Funding", + "Liquidity & Inv Portfolio", + "Capital Analysis-a", + "Income Statement 1-Qtr-Ann", + "Fiduciary Services-a" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary Ratios", + "value": "Summary Ratios" + }, + { + "label": "Noninterest Income and Expenses", + "value": "Noninterest Income and Expenses" + }, + { + "label": "Asset Yields and Funding Costs", + "value": "Asset Yields and Funding Costs" + }, + { + "label": "Off Balance Sheet Items", + "value": "Off Balance Sheet Items" + }, + { + "label": "Derivative Analysis", + "value": "Derivative Analysis" + }, + { + "label": "Balance Sheet %", + "value": "Balance Sheet %" + }, + { + "label": "Allowance & Loan Mix-a", + "value": "Allowance & Loan Mix-a" + }, + { + "label": "Allowance & Loan Mix-b", + "value": "Allowance & Loan Mix-b" + }, + { + "label": "Concentrations of Credit", + "value": "Concentrations of Credit" + }, + { + "label": "PD, Nonacc & Rest Loans-a", + "value": "PD, Nonacc & Rest Loans-a" + }, + { + "label": "PD, Nonacc & Rest Loans-b", + "value": "PD, Nonacc & Rest Loans-b" + }, + { + "label": "Interest Rate Risk-a", + "value": "Interest Rate Risk-a" + }, + { + "label": "Interest Rate Risk-b", + "value": "Interest Rate Risk-b" + }, + { + "label": "Liquidity & Funding", + "value": "Liquidity & Funding" + }, + { + "label": "Liquidity & Inv Portfolio", + "value": "Liquidity & Inv Portfolio" + }, + { + "label": "Capital Analysis-a", + "value": "Capital Analysis-a" + }, + { + "label": "Income Statement 1-Qtr-Ann", + "value": "Income Statement 1-Qtr-Ann" + }, + { + "label": "Fiduciary Services-a", + "value": "Fiduciary Services-a" + } + ] + } + } + }, + { + "name": "period", + "type": "str | None", + "description": "The reporting period end date (YYYY-MM-DD); defaults to latest.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePeerGroupDistribution", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The Interactive User's Guide definition of the line item's concept, when available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePeerGroupDistribution", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC UBPR Peer Group Average Distribution", + "description": "This report provides a distribution or range of values for all ratios that appear in the UBPR by peer group. The report can provide valuable insight into the population of banks that are used to calculate the peer average data that appears in the UBPR.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "narrative", + "hide": true + }, + { + "field": "is_header", + "hide": true + } + ] + } + } + }, + "model": "FederalReservePeerGroupDistribution" + } + }, + "/federal_reserve/ffiec/state_average": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FFIEC UBPR State Average report (state-level peer-group averages).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the UBPR State Average for South Dakota commercial banks.\nobb.federal_reserve.ffiec.state_average(state='SD', provider='federal_reserve')\n# Get a State Average section for New York savings institutions.\nobb.federal_reserve.ffiec.state_average(state='NY', group_type='savings', section='Balance Sheet %', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "state", + "type": "str | None", + "description": "The two-letter state (or territory) code to average.", + "default": "SD", + "optional": true, + "choices": [ + "AL", + "AK", + "AS", + "AZ", + "AR", + "CA", + "CO", + "CT", + "DE", + "DC", + "FL", + "GA", + "GU", + "HI", + "ID", + "IL", + "IN", + "IA", + "KS", + "KY", + "LA", + "ME", + "MD", + "MA", + "MI", + "FM", + "MN", + "MS", + "MO", + "MT", + "NE", + "NV", + "NH", + "NJ", + "NM", + "NY", + "NC", + "ND", + "OH", + "OK", + "OR", + "PA", + "PR", + "RI", + "SC", + "SD", + "TN", + "TX", + "UT", + "VT", + "VI", + "VA", + "WA", + "WV", + "WI", + "WY" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Alabama", + "value": "AL" + }, + { + "label": "Alaska", + "value": "AK" + }, + { + "label": "American Samoa", + "value": "AS" + }, + { + "label": "Arizona", + "value": "AZ" + }, + { + "label": "Arkansas", + "value": "AR" + }, + { + "label": "California", + "value": "CA" + }, + { + "label": "Colorado", + "value": "CO" + }, + { + "label": "Connecticut", + "value": "CT" + }, + { + "label": "Delaware", + "value": "DE" + }, + { + "label": "District of Columbia", + "value": "DC" + }, + { + "label": "Florida", + "value": "FL" + }, + { + "label": "Georgia", + "value": "GA" + }, + { + "label": "Guam", + "value": "GU" + }, + { + "label": "Hawaii", + "value": "HI" + }, + { + "label": "Idaho", + "value": "ID" + }, + { + "label": "Illinois", + "value": "IL" + }, + { + "label": "Indiana", + "value": "IN" + }, + { + "label": "Iowa", + "value": "IA" + }, + { + "label": "Kansas", + "value": "KS" + }, + { + "label": "Kentucky", + "value": "KY" + }, + { + "label": "Louisiana", + "value": "LA" + }, + { + "label": "Maine", + "value": "ME" + }, + { + "label": "Maryland", + "value": "MD" + }, + { + "label": "Massachusetts", + "value": "MA" + }, + { + "label": "Michigan", + "value": "MI" + }, + { + "label": "Micronesia", + "value": "FM" + }, + { + "label": "Minnesota", + "value": "MN" + }, + { + "label": "Mississippi", + "value": "MS" + }, + { + "label": "Missouri", + "value": "MO" + }, + { + "label": "Montana", + "value": "MT" + }, + { + "label": "Nebraska", + "value": "NE" + }, + { + "label": "Nevada", + "value": "NV" + }, + { + "label": "New Hampshire", + "value": "NH" + }, + { + "label": "New Jersey", + "value": "NJ" + }, + { + "label": "New Mexico", + "value": "NM" + }, + { + "label": "New York", + "value": "NY" + }, + { + "label": "North Carolina", + "value": "NC" + }, + { + "label": "North Dakota", + "value": "ND" + }, + { + "label": "Ohio", + "value": "OH" + }, + { + "label": "Oklahoma", + "value": "OK" + }, + { + "label": "Oregon", + "value": "OR" + }, + { + "label": "Pennsylvania", + "value": "PA" + }, + { + "label": "Puerto Rico", + "value": "PR" + }, + { + "label": "Rhode Island", + "value": "RI" + }, + { + "label": "South Carolina", + "value": "SC" + }, + { + "label": "South Dakota", + "value": "SD" + }, + { + "label": "Tennessee", + "value": "TN" + }, + { + "label": "Texas", + "value": "TX" + }, + { + "label": "Utah", + "value": "UT" + }, + { + "label": "Vermont", + "value": "VT" + }, + { + "label": "Virgin Islands", + "value": "VI" + }, + { + "label": "Virginia", + "value": "VA" + }, + { + "label": "Washington", + "value": "WA" + }, + { + "label": "West Virginia", + "value": "WV" + }, + { + "label": "Wisconsin", + "value": "WI" + }, + { + "label": "Wyoming", + "value": "WY" + } + ] + } + } + }, + { + "name": "group_type", + "type": "str | None", + "description": "The institution peer group to average across the state.", + "default": "commercial", + "optional": true, + "choices": [ + "commercial", + "savings" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Commercial", + "value": "commercial" + }, + { + "label": "Savings", + "value": "savings" + } + ] + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "The UBPR State Average report section (page) to return.", + "default": "Summary Ratios", + "optional": true, + "choices": [ + "Summary Ratios", + "Noninterest Income and Expenses", + "Asset Yields and Funding Costs", + "Off Balance Sheet Items", + "Derivative Analysis", + "Balance Sheet %", + "Allowance & Loan Mix-a", + "Allowance & Loan Mix-b", + "Concentrations of Credit", + "PD, Nonacc & Rest Loans-a", + "PD, Nonacc & Rest Loans-b", + "Interest Rate Risk-a", + "Interest Rate Risk-b", + "Liquidity & Funding", + "Liquidity & Inv Portfolio", + "Capital Analysis-a", + "Income Statement 1-Qtr-Ann", + "Fiduciary Services-a" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary Ratios", + "value": "Summary Ratios" + }, + { + "label": "Noninterest Income and Expenses", + "value": "Noninterest Income and Expenses" + }, + { + "label": "Asset Yields and Funding Costs", + "value": "Asset Yields and Funding Costs" + }, + { + "label": "Off Balance Sheet Items", + "value": "Off Balance Sheet Items" + }, + { + "label": "Derivative Analysis", + "value": "Derivative Analysis" + }, + { + "label": "Balance Sheet %", + "value": "Balance Sheet %" + }, + { + "label": "Allowance & Loan Mix-a", + "value": "Allowance & Loan Mix-a" + }, + { + "label": "Allowance & Loan Mix-b", + "value": "Allowance & Loan Mix-b" + }, + { + "label": "Concentrations of Credit", + "value": "Concentrations of Credit" + }, + { + "label": "PD, Nonacc & Rest Loans-a", + "value": "PD, Nonacc & Rest Loans-a" + }, + { + "label": "PD, Nonacc & Rest Loans-b", + "value": "PD, Nonacc & Rest Loans-b" + }, + { + "label": "Interest Rate Risk-a", + "value": "Interest Rate Risk-a" + }, + { + "label": "Interest Rate Risk-b", + "value": "Interest Rate Risk-b" + }, + { + "label": "Liquidity & Funding", + "value": "Liquidity & Funding" + }, + { + "label": "Liquidity & Inv Portfolio", + "value": "Liquidity & Inv Portfolio" + }, + { + "label": "Capital Analysis-a", + "value": "Capital Analysis-a" + }, + { + "label": "Income Statement 1-Qtr-Ann", + "value": "Income Statement 1-Qtr-Ann" + }, + { + "label": "Fiduciary Services-a", + "value": "Fiduciary Services-a" + } + ] + } + } + }, + { + "name": "all_periods", + "type": "bool | None", + "description": "Return every reported period instead of only the most recent five.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveStateAverage", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The MDRM definition of the line item, when available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveStateAverage", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC UBPR State Average Report", + "description": "This report provides summary UBPR ratio data and selected aggregate information averaged by state. A further breakdown of average statistical data is provided by asset size. The information is provided for all states and territories in UBPR format.", + "gridData": { + "w": 40, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "narrative", + "hide": true + }, + { + "field": "is_header", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveStateAverage" + } + }, + "/federal_reserve/ffiec/list_of_banks_peer_group": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FFIEC List of Banks in a UBPR peer group for a reporting period.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the roster of banks in UBPR peer group 1 (the largest commercial banks) for the latest reporting period.\nobb.federal_reserve.ffiec.list_of_banks_peer_group(peer_group='1', provider='federal_reserve')\n# Get the banks in a peer group for a specific period.\nobb.federal_reserve.ffiec.list_of_banks_peer_group(peer_group='4', date='12/31/2025', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "peer_group", + "type": "str | None", + "description": "The UBPR peer-group name (e.g. '1', 'NATIONAL', 'ALCOM').", + "default": "1", + "optional": true, + "choices": [ + "1", + "101", + "101M", + "101S", + "102", + "102M", + "102S", + "103", + "103M", + "103S", + "104", + "104M", + "104S", + "2", + "201", + "202", + "2022", + "2023", + "2024", + "2025", + "2026", + "203", + "3", + "301", + "4", + "401", + "5", + "6", + "7", + "8", + "AKCOM", + "AKSVG", + "ALCOM", + "ALSVG", + "ARCOM", + "ARSVG", + "AZCOM", + "AZNDT", + "AZSVG", + "BKR", + "CABKR", + "CACOM", + "CANDT", + "CASVG", + "COBKR", + "COCOM", + "COM", + "COSVG", + "CRC", + "CTCOM", + "CTSVG", + "DCCOM", + "DECOM", + "DECRC", + "DENDT", + "DESVG", + "FLCOM", + "FLCRC", + "FLNDT", + "FLSVG", + "FMCOM", + "GACOM", + "GANDT", + "GASVG", + "GUCOM", + "HICOM", + "IACOM", + "IANDT", + "IASVG", + "IDCOM", + "IDSVG", + "ILCOM", + "ILNDT", + "ILSVG", + "INCOM", + "INNDT", + "INSVG", + "KSBKR", + "KSCOM", + "KSSVG", + "KYBKR", + "KYCOM", + "KYSVG", + "LABKR", + "LACOM", + "LASVG", + "MACOM", + "MANDT", + "MASVG", + "MDCOM", + "MDSVG", + "MECOM", + "MESVG", + "MICOM", + "MINDT", + "MISVG", + "MNBKR", + "MNCOM", + "MNNDT", + "MNSVG", + "MOBKR", + "MOCOM", + "MONDT", + "MOSVG", + "MSCOM", + "MSSVG", + "MTCOM", + "MTSVG", + "NATIONAL", + "NCCOM", + "NCNDT", + "NCSVG", + "NDCOM", + "NDSVG", + "NDT", + "NECOM", + "NESVG", + "NHCOM", + "NHSVG", + "NJCOM", + "NJSVG", + "NMCOM", + "NMSVG", + "NVCOM", + "NVCRC", + "NVNDT", + "NVSVG", + "NYCOM", + "NYNDT", + "NYSVG", + "OHCOM", + "OHNDT", + "OHSVG", + "OKBKR", + "OKCOM", + "OKCRC", + "OKNDT", + "OKSVG", + "ORCOM", + "ORNDT", + "ORSVG", + "PABKR", + "PACOM", + "PANDT", + "PASVG", + "PRCOM", + "RICOM", + "RISVG", + "SCCOM", + "SCSVG", + "SDCOM", + "SDNDT", + "SDSVG", + "SVG", + "TNCOM", + "TNSVG", + "TRST301", + "TRST302", + "TRST303", + "TRST304", + "TRST305", + "TXBKR", + "TXCOM", + "TXNDT", + "TXSVG", + "UTCOM", + "UTCRC", + "UTNDT", + "VABKR", + "VACOM", + "VACRC", + "VANDT", + "VASVG", + "VICOM", + "VTCOM", + "VTSVG", + "WACOM", + "WASVG", + "WIBKR", + "WICOM", + "WINDT", + "WISVG", + "WVCOM", + "WVNDT", + "WVSVG", + "WYCOM", + "WYSVG" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "1 -- Insured commercial banks having assets greater than $100 billion", + "value": "1" + }, + { + "label": "101 -- Insured savings banks having assets greater than $1 billion", + "value": "101" + }, + { + "label": "101M -- Mutually-owned insured savings banks having assets greater than $1 billion", + "value": "101M" + }, + { + "label": "101S -- Stock-owned insured savings banks having assets greater than $1 billion", + "value": "101S" + }, + { + "label": "102 -- Insured savings banks having assets between $300 million and $1 billion", + "value": "102" + }, + { + "label": "102M -- Mutually-owned insured savings banks having assets between $300 million and $1 billion", + "value": "102M" + }, + { + "label": "102S -- Stock-owned insured savings banks having assets between $300 million and $1 billion", + "value": "102S" + }, + { + "label": "103 -- Insured savings banks having assets between $100 million and $300 million", + "value": "103" + }, + { + "label": "103M -- Mutually-owned insured savings banks having assets between $100 million and $300 million", + "value": "103M" + }, + { + "label": "103S -- Stock-owned insured savings banks having assets between $100 million and $300 million", + "value": "103S" + }, + { + "label": "104 -- Insured savings banks having assets less than $100 million", + "value": "104" + }, + { + "label": "104M -- Mutually-owned insured savings banks having assets less than $100 million", + "value": "104M" + }, + { + "label": "104S -- Stock-owned insured savings banks having assets less than $100 million", + "value": "104S" + }, + { + "label": "2 -- Insured commercial banks having assets between $10 billion and $100 billion", + "value": "2" + }, + { + "label": "201 -- Credit card specialty banks having assets greater than $ 3 billion", + "value": "201" + }, + { + "label": "202 -- Credit card specialty banks having assets between $1 billion and $3 billion", + "value": "202" + }, + { + "label": "2022 -- Denovo banks opened in 2022 having assets less than $750 million", + "value": "2022" + }, + { + "label": "2023 -- Denovo banks opened in 2023 having assets less than $750 million", + "value": "2023" + }, + { + "label": "2024 -- Denovo banks opened in 2024 having assets less than $750 million", + "value": "2024" + }, + { + "label": "2025 -- Denovo banks opened in 2025 having assets less than $750 million", + "value": "2025" + }, + { + "label": "2026 -- Denovo banks opened in 2026 having assets less than $750 million", + "value": "2026" + }, + { + "label": "203 -- Credit card specialty banks having assets less than $1 billion", + "value": "203" + }, + { + "label": "3 -- Insured commercial banks having assets between $3 billion and $10 billion", + "value": "3" + }, + { + "label": "301 -- Bankers banks", + "value": "301" + }, + { + "label": "4 -- Insured commercial banks having assets between $1 billion and $3 billion", + "value": "4" + }, + { + "label": "401 -- All Non-insured Non-deposit Trust Companies", + "value": "401" + }, + { + "label": "5 -- Insured commercial banks having assets between $300 million and $1 billion", + "value": "5" + }, + { + "label": "6 -- Insured commercial banks having assets between $100 million and $300 million", + "value": "6" + }, + { + "label": "7 -- Insured commercial banks having assets between $50 million and $100 million", + "value": "7" + }, + { + "label": "8 -- Insured commercial banks having assets less than $50 million", + "value": "8" + }, + { + "label": "AKCOM -- All Insured Commercial Banks in Alaska", + "value": "AKCOM" + }, + { + "label": "AKSVG -- All Insured Savings Banks in Alaska", + "value": "AKSVG" + }, + { + "label": "ALCOM -- All Insured Commercial Banks in Alabama", + "value": "ALCOM" + }, + { + "label": "ALSVG -- All Insured Savings Banks in Alabama", + "value": "ALSVG" + }, + { + "label": "ARCOM -- All Insured Commercial Banks in Arkansas", + "value": "ARCOM" + }, + { + "label": "ARSVG -- All Insured Savings Banks in Arkansas", + "value": "ARSVG" + }, + { + "label": "AZCOM -- All Insured Commercial Banks in Arizona", + "value": "AZCOM" + }, + { + "label": "AZNDT -- All Non-insured Non-deposit Trust Companies in Arizona", + "value": "AZNDT" + }, + { + "label": "AZSVG -- All Insured Savings Banks in Arizona", + "value": "AZSVG" + }, + { + "label": "BKR -- Bankers banks", + "value": "BKR" + }, + { + "label": "CABKR -- All Bankers Banks in California", + "value": "CABKR" + }, + { + "label": "CACOM -- All Insured Commercial Banks in California", + "value": "CACOM" + }, + { + "label": "CANDT -- All Non-insured Non-deposit Trust Companies in California", + "value": "CANDT" + }, + { + "label": "CASVG -- All Insured Savings Banks in California", + "value": "CASVG" + }, + { + "label": "COBKR -- All Bankers Banks in Colorado", + "value": "COBKR" + }, + { + "label": "COCOM -- All Insured Commercial Banks in Colorado", + "value": "COCOM" + }, + { + "label": "COM -- All insured commercial banks", + "value": "COM" + }, + { + "label": "COSVG -- All Insured Savings Banks in Colorado", + "value": "COSVG" + }, + { + "label": "CRC -- All credit card specialty banks", + "value": "CRC" + }, + { + "label": "CTCOM -- All Insured Commercial Banks in Connecticut", + "value": "CTCOM" + }, + { + "label": "CTSVG -- All Insured Savings Banks in Connecticut", + "value": "CTSVG" + }, + { + "label": "DCCOM -- All Insured Commercial Banks in District of Columbia", + "value": "DCCOM" + }, + { + "label": "DECOM -- All Insured Commercial Banks in Delaware", + "value": "DECOM" + }, + { + "label": "DECRC -- All Credit Card Specialty Banks in Delaware", + "value": "DECRC" + }, + { + "label": "DENDT -- All Non-insured Non-deposit Trust Companies in Delaware", + "value": "DENDT" + }, + { + "label": "DESVG -- All Insured Savings Banks in Delaware", + "value": "DESVG" + }, + { + "label": "FLCOM -- All Insured Commercial Banks in Florida", + "value": "FLCOM" + }, + { + "label": "FLCRC -- All Credit Card Specialty Banks in Florida", + "value": "FLCRC" + }, + { + "label": "FLNDT -- All Non-insured Non-deposit Trust Companies in Florida", + "value": "FLNDT" + }, + { + "label": "FLSVG -- All Insured Savings Banks in Florida", + "value": "FLSVG" + }, + { + "label": "FMCOM -- All Insured Commercial Banks in Micronesia", + "value": "FMCOM" + }, + { + "label": "GACOM -- All Insured Commercial Banks in Georgia", + "value": "GACOM" + }, + { + "label": "GANDT -- All Non-insured Non-deposit Trust Companies in Georgia", + "value": "GANDT" + }, + { + "label": "GASVG -- All Insured Savings Banks in Georgia", + "value": "GASVG" + }, + { + "label": "GUCOM -- All Insured Commercial Banks in Guam", + "value": "GUCOM" + }, + { + "label": "HICOM -- All Insured Commercial Banks in Hawaii", + "value": "HICOM" + }, + { + "label": "IACOM -- All Insured Commercial Banks in Iowa", + "value": "IACOM" + }, + { + "label": "IANDT -- All Non-insured Non-deposit Trust Companies in Iowa", + "value": "IANDT" + }, + { + "label": "IASVG -- All Insured Savings Banks in Iowa", + "value": "IASVG" + }, + { + "label": "IDCOM -- All Insured Commercial Banks in Idaho", + "value": "IDCOM" + }, + { + "label": "IDSVG -- All Insured Savings Banks in Idaho", + "value": "IDSVG" + }, + { + "label": "ILCOM -- All Insured Commercial Banks in Illinois", + "value": "ILCOM" + }, + { + "label": "ILNDT -- All Non-insured Non-deposit Trust Companies in Illinois", + "value": "ILNDT" + }, + { + "label": "ILSVG -- All Insured Savings Banks in Illinois", + "value": "ILSVG" + }, + { + "label": "INCOM -- All Insured Commercial Banks in Indiana", + "value": "INCOM" + }, + { + "label": "INNDT -- All Non-insured Non-deposit Trust Companies in Indiana", + "value": "INNDT" + }, + { + "label": "INSVG -- All Insured Savings Banks in Indiana", + "value": "INSVG" + }, + { + "label": "KSBKR -- All Bankers Banks in Kansas", + "value": "KSBKR" + }, + { + "label": "KSCOM -- All Insured Commercial Banks in Kansas", + "value": "KSCOM" + }, + { + "label": "KSSVG -- All Insured Savings Banks in Kansas", + "value": "KSSVG" + }, + { + "label": "KYBKR -- All Bankers Banks in Kentucky", + "value": "KYBKR" + }, + { + "label": "KYCOM -- All Insured Commercial Banks in Kentucky", + "value": "KYCOM" + }, + { + "label": "KYSVG -- All Insured Savings Banks in Kentucky", + "value": "KYSVG" + }, + { + "label": "LABKR -- All Bankers Banks in Louisiana", + "value": "LABKR" + }, + { + "label": "LACOM -- All Insured Commercial Banks in Louisiana", + "value": "LACOM" + }, + { + "label": "LASVG -- All Insured Savings Banks in Louisiana", + "value": "LASVG" + }, + { + "label": "MACOM -- All Insured Commercial Banks in Massachusetts", + "value": "MACOM" + }, + { + "label": "MANDT -- All Non-insured Non-deposit Trust Companies in Massachusetts", + "value": "MANDT" + }, + { + "label": "MASVG -- All Insured Savings Banks in Massachusetts", + "value": "MASVG" + }, + { + "label": "MDCOM -- All Insured Commercial Banks in Maryland", + "value": "MDCOM" + }, + { + "label": "MDSVG -- All Insured Savings Banks in Maryland", + "value": "MDSVG" + }, + { + "label": "MECOM -- All Insured Commercial Banks in Maine", + "value": "MECOM" + }, + { + "label": "MESVG -- All Insured Savings Banks in Maine", + "value": "MESVG" + }, + { + "label": "MICOM -- All Insured Commercial Banks in Michigan", + "value": "MICOM" + }, + { + "label": "MINDT -- All Non-insured Non-deposit Trust Companies in Michigan", + "value": "MINDT" + }, + { + "label": "MISVG -- All Insured Savings Banks in Michigan", + "value": "MISVG" + }, + { + "label": "MNBKR -- All Bankers Banks in Minnesota", + "value": "MNBKR" + }, + { + "label": "MNCOM -- All Insured Commercial Banks in Minnesota", + "value": "MNCOM" + }, + { + "label": "MNNDT -- All Non-insured Non-deposit Trust Companies in Minnesota", + "value": "MNNDT" + }, + { + "label": "MNSVG -- All Insured Savings Banks in Minnesota", + "value": "MNSVG" + }, + { + "label": "MOBKR -- All Bankers Banks in Missouri", + "value": "MOBKR" + }, + { + "label": "MOCOM -- All Insured Commercial Banks in Missouri", + "value": "MOCOM" + }, + { + "label": "MONDT -- All Non-insured Non-deposit Trust Companies in Missouri", + "value": "MONDT" + }, + { + "label": "MOSVG -- All Insured Savings Banks in Missouri", + "value": "MOSVG" + }, + { + "label": "MSCOM -- All Insured Commercial Banks in Mississippi", + "value": "MSCOM" + }, + { + "label": "MSSVG -- All Insured Savings Banks in Mississippi", + "value": "MSSVG" + }, + { + "label": "MTCOM -- All Insured Commercial Banks in Montana", + "value": "MTCOM" + }, + { + "label": "MTSVG -- All Insured Savings Banks in Montana", + "value": "MTSVG" + }, + { + "label": "NATIONAL -- All banks in nation", + "value": "NATIONAL" + }, + { + "label": "NCCOM -- All Insured Commercial Banks in North Carolina", + "value": "NCCOM" + }, + { + "label": "NCNDT -- All Non-insured Non-deposit Trust Companies in North Carolina", + "value": "NCNDT" + }, + { + "label": "NCSVG -- All Insured Savings Banks in North Carolina", + "value": "NCSVG" + }, + { + "label": "NDCOM -- All Insured Commercial Banks in North Dakota", + "value": "NDCOM" + }, + { + "label": "NDSVG -- All Insured Savings Banks in North Dakota", + "value": "NDSVG" + }, + { + "label": "NDT -- All Non-insured Non-deposit Trust Companies", + "value": "NDT" + }, + { + "label": "NECOM -- All Insured Commercial Banks in Nebraska", + "value": "NECOM" + }, + { + "label": "NESVG -- All Insured Savings Banks in Nebraska", + "value": "NESVG" + }, + { + "label": "NHCOM -- All Insured Commercial Banks in New Hampshire", + "value": "NHCOM" + }, + { + "label": "NHSVG -- All Insured Savings Banks in New Hampshire", + "value": "NHSVG" + }, + { + "label": "NJCOM -- All Insured Commercial Banks in New Jersey", + "value": "NJCOM" + }, + { + "label": "NJSVG -- All Insured Savings Banks in New Jersey", + "value": "NJSVG" + }, + { + "label": "NMCOM -- All Insured Commercial Banks in New Mexico", + "value": "NMCOM" + }, + { + "label": "NMSVG -- All Insured Savings Banks in New Mexico", + "value": "NMSVG" + }, + { + "label": "NVCOM -- All Insured Commercial Banks in Nevada", + "value": "NVCOM" + }, + { + "label": "NVCRC -- All Credit Card Specialty Banks in Nevada", + "value": "NVCRC" + }, + { + "label": "NVNDT -- All Non-insured Non-deposit Trust Companies in Nevada", + "value": "NVNDT" + }, + { + "label": "NVSVG -- All Insured Savings Banks in Nevada", + "value": "NVSVG" + }, + { + "label": "NYCOM -- All Insured Commercial Banks in New York", + "value": "NYCOM" + }, + { + "label": "NYNDT -- All Non-insured Non-deposit Trust Companies in New York", + "value": "NYNDT" + }, + { + "label": "NYSVG -- All Insured Savings Banks in New York", + "value": "NYSVG" + }, + { + "label": "OHCOM -- All Insured Commercial Banks in Ohio", + "value": "OHCOM" + }, + { + "label": "OHNDT -- All Non-insured Non-deposit Trust Companies in Ohio", + "value": "OHNDT" + }, + { + "label": "OHSVG -- All Insured Savings Banks in Ohio", + "value": "OHSVG" + }, + { + "label": "OKBKR -- All Bankers Banks in Oklahoma", + "value": "OKBKR" + }, + { + "label": "OKCOM -- All Insured Commercial Banks in Oklahoma", + "value": "OKCOM" + }, + { + "label": "OKCRC -- All Credit Card Specialty Banks in Oklahoma", + "value": "OKCRC" + }, + { + "label": "OKNDT -- All Non-insured Non-deposit Trust Companies in Oklahoma", + "value": "OKNDT" + }, + { + "label": "OKSVG -- All Insured Savings Banks in Oklahoma", + "value": "OKSVG" + }, + { + "label": "ORCOM -- All Insured Commercial Banks in Oregon", + "value": "ORCOM" + }, + { + "label": "ORNDT -- All Non-insured Non-deposit Trust Companies in Oregon", + "value": "ORNDT" + }, + { + "label": "ORSVG -- All Insured Savings Banks in Oregon", + "value": "ORSVG" + }, + { + "label": "PABKR -- All Bankers Banks in Pennsylvania", + "value": "PABKR" + }, + { + "label": "PACOM -- All Insured Commercial Banks in Pennsylvania", + "value": "PACOM" + }, + { + "label": "PANDT -- All Non-insured Non-deposit Trust Companies in Pennsylvania", + "value": "PANDT" + }, + { + "label": "PASVG -- All Insured Savings Banks in Pennsylvania", + "value": "PASVG" + }, + { + "label": "PRCOM -- All Insured Commercial Banks in Puerto Rico", + "value": "PRCOM" + }, + { + "label": "RICOM -- All Insured Commercial Banks in Rhode Island", + "value": "RICOM" + }, + { + "label": "RISVG -- All Insured Savings Banks in Rhode Island", + "value": "RISVG" + }, + { + "label": "SCCOM -- All Insured Commercial Banks in South Carolina", + "value": "SCCOM" + }, + { + "label": "SCSVG -- All Insured Savings Banks in South Carolina", + "value": "SCSVG" + }, + { + "label": "SDCOM -- All Insured Commercial Banks in South Dakota", + "value": "SDCOM" + }, + { + "label": "SDNDT -- All Non-insured Non-deposit Trust Companies in South Dakota", + "value": "SDNDT" + }, + { + "label": "SDSVG -- All Insured Savings Banks in South Dakota", + "value": "SDSVG" + }, + { + "label": "SVG -- All insured savings banks", + "value": "SVG" + }, + { + "label": "TNCOM -- All Insured Commercial Banks in Tennessee", + "value": "TNCOM" + }, + { + "label": "TNSVG -- All Insured Savings Banks in Tennessee", + "value": "TNSVG" + }, + { + "label": "TRST301 -- Trust Assets in excess of $100 billion", + "value": "TRST301" + }, + { + "label": "TRST302 -- Trust Assets between $10 billion and $100 billion", + "value": "TRST302" + }, + { + "label": "TRST303 -- Trust Assets between $1 billion and $10 billion", + "value": "TRST303" + }, + { + "label": "TRST304 -- Trust Assets between $250 million and $1 billion", + "value": "TRST304" + }, + { + "label": "TRST305 -- Trust Assets less than $250 million", + "value": "TRST305" + }, + { + "label": "TXBKR -- All Bankers Banks in Texas", + "value": "TXBKR" + }, + { + "label": "TXCOM -- All Insured Commercial Banks in Texas", + "value": "TXCOM" + }, + { + "label": "TXNDT -- All Non-insured Non-deposit Trust Companies in Texas", + "value": "TXNDT" + }, + { + "label": "TXSVG -- All Insured Savings Banks in Texas", + "value": "TXSVG" + }, + { + "label": "UTCOM -- All Insured Commercial Banks in Utah", + "value": "UTCOM" + }, + { + "label": "UTCRC -- All Credit Card Specialty Banks in Utah", + "value": "UTCRC" + }, + { + "label": "UTNDT -- All Non-insured Non-deposit Trust Companies in Utah", + "value": "UTNDT" + }, + { + "label": "VABKR -- All Bankers Banks in Virginia", + "value": "VABKR" + }, + { + "label": "VACOM -- All Insured Commercial Banks in Virginia", + "value": "VACOM" + }, + { + "label": "VACRC -- All Credit Card Specialty Banks in Virginia", + "value": "VACRC" + }, + { + "label": "VANDT -- All Non-insured Non-deposit Trust Companies in Virginia", + "value": "VANDT" + }, + { + "label": "VASVG -- All Insured Savings Banks in Virginia", + "value": "VASVG" + }, + { + "label": "VICOM -- All Insured Commercial Banks in Virgin Islands", + "value": "VICOM" + }, + { + "label": "VTCOM -- All Insured Commercial Banks in Vermont", + "value": "VTCOM" + }, + { + "label": "VTSVG -- All Insured Savings Banks in Vermont", + "value": "VTSVG" + }, + { + "label": "WACOM -- All Insured Commercial Banks in Washington", + "value": "WACOM" + }, + { + "label": "WASVG -- All Insured Savings Banks in Washington", + "value": "WASVG" + }, + { + "label": "WIBKR -- All Bankers Banks in Wisconsin", + "value": "WIBKR" + }, + { + "label": "WICOM -- All Insured Commercial Banks in Wisconsin", + "value": "WICOM" + }, + { + "label": "WINDT -- All Non-insured Non-deposit Trust Companies in Wisconsin", + "value": "WINDT" + }, + { + "label": "WISVG -- All Insured Savings Banks in Wisconsin", + "value": "WISVG" + }, + { + "label": "WVCOM -- All Insured Commercial Banks in West Virginia", + "value": "WVCOM" + }, + { + "label": "WVNDT -- All Non-insured Non-deposit Trust Companies in West Virginia", + "value": "WVNDT" + }, + { + "label": "WVSVG -- All Insured Savings Banks in West Virginia", + "value": "WVSVG" + }, + { + "label": "WYCOM -- All Insured Commercial Banks in Wyoming", + "value": "WYCOM" + }, + { + "label": "WYSVG -- All Insured Savings Banks in Wyoming", + "value": "WYSVG" + } + ] + } + } + }, + { + "name": "date", + "type": "str | None | str", + "description": "The reporting period end date; defaults to the latest cycle.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveListOfBanksPeerGroup", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "rssd_id", + "type": "str | None", + "description": "The bank's RSSD identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fdic_cert", + "type": "str | None", + "description": "The bank's FDIC certificate number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "charter_class", + "type": "str | None", + "description": "The bank's charter class code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The bank's legal name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "city", + "type": "str | None", + "description": "The bank's city.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "The bank's state abbreviation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state_name", + "type": "str | None", + "description": "The bank's state name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "offices", + "type": "int | None", + "description": "The bank's number of offices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_assets", + "type": "int | None", + "description": "The bank's average assets, in U.S. dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "int | None", + "description": "The bank's quarterly net income, in U.S. dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "The bank's headquarters latitude.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "The bank's headquarters longitude.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveListOfBanksPeerGroup", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC List of Banks in Peer Group", + "description": "This report provides a list of banks by peer group. The list includes core information such as location, assets and net income.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "rssd_id", + "headerName": "ID RSSD", + "cellDataType": "text", + "pinned": "left", + "width": 110 + }, + { + "field": "name", + "headerName": "Name", + "cellDataType": "text", + "width": 260 + }, + { + "field": "fdic_cert", + "headerName": "FDIC Cert.", + "cellDataType": "text" + }, + { + "field": "charter_class", + "headerName": "Class", + "cellDataType": "text" + }, + { + "field": "city", + "headerName": "City", + "cellDataType": "text" + }, + { + "field": "state", + "headerName": "State", + "cellDataType": "text" + }, + { + "field": "offices", + "headerName": "No. Offices", + "cellDataType": "number" + }, + { + "field": "average_assets", + "headerName": "Average Assets ($)", + "cellDataType": "number", + "sort": "desc" + }, + { + "field": "net_income", + "headerName": "Net Income ($)", + "cellDataType": "number" + }, + { + "field": "state_name", + "hide": true + }, + { + "field": "latitude", + "hide": true + }, + { + "field": "longitude", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveListOfBanksPeerGroup" + } + }, + "/federal_reserve/ffiec/call_report_sectioned": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a commercial bank's FFIEC Call Report by schedule, periods as columns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get a bank's Call Report balance sheet by ticker; the symbol resolves to the subsidiary bank, not the holding company.\nobb.federal_reserve.ffiec.call_report_sectioned(symbol='WFC', provider='federal_reserve')\n# Get a Call Report schedule by RSSD identifier.\nobb.federal_reserve.ffiec.call_report_sectioned(rssd_id='451965', section='Schedule RI - Income Statement', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "symbol", + "type": "str | None", + "description": "The bank's stock ticker; resolved to the subsidiary bank that files the Call Report (not its parent holding company).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "The bank's RSSD identifier (the Call Report IDRSSD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fdic_cert", + "type": "str | None", + "description": "The bank's FDIC certificate number (alternative to `rssd_id`).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "str | None", + "description": "The Call Report schedule (section) to return.", + "default": "Schedule RC - Balance Sheet", + "optional": true, + "choices": [ + "Schedule RI - Income Statement", + "Schedule RI-A - Changes in Bank Equity Capital", + "Schedule RI-B Part I - Charge-offs and Recoveries on Loans and Leases", + "Schedule RI-B Part II - Changes in Allowances for Credit Losses", + "Schedule RI-C - Disaggregated Data on the Allowances for Credit Losses", + "Schedule RI-D - Income from Foreign Offices", + "Schedule RI-E - Explanations", + "Schedule RC - Balance Sheet", + "Schedule RC-A - Cash and Balances Due From Depository Institutions", + "Schedule RC-B - Securities", + "Schedule RC-C Part I - Loans and Leases", + "Schedule RC-C Part II - Loans to Small Businesses and Small Farms", + "Schedule RC-D - Trading Assets and Liabilities", + "Schedule RC-E - Deposit Liabilities", + "Schedule RC-E Part I - Deposits in Domestic Offices", + "Schedule RC-F - Other Assets", + "Schedule RC-G - Other Liabilities", + "Schedule RC-H - Selected Balance Sheet Items for Domestic Offices", + "Schedule RC-I - Assets and Liabilities of IBFs", + "Schedule RC-K - Quarterly Averages", + "Schedule RC-L - Derivatives and Off-Balance Sheet Items", + "Schedule RC-M - Memoranda", + "Schedule RC-N - Past Due and Nonaccrual Loans Leases and Other Assets", + "Schedule RC-O - Other Data for Deposit Insurance and FICO Assessments", + "Schedule RC-P - 1-4 Family Residential Mortgage Banking Activities", + "Schedule RC-Q - Assets and Liabilities Measured at Fair Value on a Recurring Basis", + "Schedule RC-R Part I - Regulatory Capital Components and Ratios", + "Schedule RC-R Part II - Risk-Weighted Assets", + "Schedule RC-S - Servicing Securitization and Asset Sale Activities", + "Schedule RC-T - Fiduciary and Related Services", + "Schedule RC-V - Variable Interest Entities", + "Schedule SU - Supplemental Information" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Schedule RI - Income Statement", + "value": "Schedule RI - Income Statement" + }, + { + "label": "Schedule RI-A - Changes in Bank Equity Capital", + "value": "Schedule RI-A - Changes in Bank Equity Capital" + }, + { + "label": "Schedule RI-B Part I - Charge-offs and Recoveries on Loans and Leases", + "value": "Schedule RI-B Part I - Charge-offs and Recoveries on Loans and Leases" + }, + { + "label": "Schedule RI-B Part II - Changes in Allowances for Credit Losses", + "value": "Schedule RI-B Part II - Changes in Allowances for Credit Losses" + }, + { + "label": "Schedule RI-C - Disaggregated Data on the Allowances for Credit Losses", + "value": "Schedule RI-C - Disaggregated Data on the Allowances for Credit Losses" + }, + { + "label": "Schedule RI-D - Income from Foreign Offices", + "value": "Schedule RI-D - Income from Foreign Offices" + }, + { + "label": "Schedule RI-E - Explanations", + "value": "Schedule RI-E - Explanations" + }, + { + "label": "Schedule RC - Balance Sheet", + "value": "Schedule RC - Balance Sheet" + }, + { + "label": "Schedule RC-A - Cash and Balances Due From Depository Institutions", + "value": "Schedule RC-A - Cash and Balances Due From Depository Institutions" + }, + { + "label": "Schedule RC-B - Securities", + "value": "Schedule RC-B - Securities" + }, + { + "label": "Schedule RC-C Part I - Loans and Leases", + "value": "Schedule RC-C Part I - Loans and Leases" + }, + { + "label": "Schedule RC-C Part II - Loans to Small Businesses and Small Farms", + "value": "Schedule RC-C Part II - Loans to Small Businesses and Small Farms" + }, + { + "label": "Schedule RC-D - Trading Assets and Liabilities", + "value": "Schedule RC-D - Trading Assets and Liabilities" + }, + { + "label": "Schedule RC-E - Deposit Liabilities", + "value": "Schedule RC-E - Deposit Liabilities" + }, + { + "label": "Schedule RC-E Part I - Deposits in Domestic Offices", + "value": "Schedule RC-E Part I - Deposits in Domestic Offices" + }, + { + "label": "Schedule RC-F - Other Assets", + "value": "Schedule RC-F - Other Assets" + }, + { + "label": "Schedule RC-G - Other Liabilities", + "value": "Schedule RC-G - Other Liabilities" + }, + { + "label": "Schedule RC-H - Selected Balance Sheet Items for Domestic Offices", + "value": "Schedule RC-H - Selected Balance Sheet Items for Domestic Offices" + }, + { + "label": "Schedule RC-I - Assets and Liabilities of IBFs", + "value": "Schedule RC-I - Assets and Liabilities of IBFs" + }, + { + "label": "Schedule RC-K - Quarterly Averages", + "value": "Schedule RC-K - Quarterly Averages" + }, + { + "label": "Schedule RC-L - Derivatives and Off-Balance Sheet Items", + "value": "Schedule RC-L - Derivatives and Off-Balance Sheet Items" + }, + { + "label": "Schedule RC-M - Memoranda", + "value": "Schedule RC-M - Memoranda" + }, + { + "label": "Schedule RC-N - Past Due and Nonaccrual Loans Leases and Other Assets", + "value": "Schedule RC-N - Past Due and Nonaccrual Loans Leases and Other Assets" + }, + { + "label": "Schedule RC-O - Other Data for Deposit Insurance and FICO Assessments", + "value": "Schedule RC-O - Other Data for Deposit Insurance and FICO Assessments" + }, + { + "label": "Schedule RC-P - 1-4 Family Residential Mortgage Banking Activities", + "value": "Schedule RC-P - 1-4 Family Residential Mortgage Banking Activities" + }, + { + "label": "Schedule RC-Q - Assets and Liabilities Measured at Fair Value on a Recurring Basis", + "value": "Schedule RC-Q - Assets and Liabilities Measured at Fair Value on a Recurring Basis" + }, + { + "label": "Schedule RC-R Part I - Regulatory Capital Components and Ratios", + "value": "Schedule RC-R Part I - Regulatory Capital Components and Ratios" + }, + { + "label": "Schedule RC-R Part II - Risk-Weighted Assets", + "value": "Schedule RC-R Part II - Risk-Weighted Assets" + }, + { + "label": "Schedule RC-S - Servicing Securitization and Asset Sale Activities", + "value": "Schedule RC-S - Servicing Securitization and Asset Sale Activities" + }, + { + "label": "Schedule RC-T - Fiduciary and Related Services", + "value": "Schedule RC-T - Fiduciary and Related Services" + }, + { + "label": "Schedule RC-V - Variable Interest Entities", + "value": "Schedule RC-V - Variable Interest Entities" + }, + { + "label": "Schedule SU - Supplemental Information", + "value": "Schedule SU - Supplemental Information" + } + ] + } + } + }, + { + "name": "all_periods", + "type": "bool | None", + "description": "Return every reported period instead of only the most recent five.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveCallReportSectioned", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The MDRM definition of the line item, shown in a hover card.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveCallReportSectioned", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC Call Report (Sectioned)", + "description": "A commercial bank's FFIEC Call Report rendered by schedule \u2014 line items across the five most recent quarters, in the Call Report's own section layout.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveCallReportSectioned" + } + }, + "/federal_reserve/ffiec/country_exposure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FFIEC E.16 Country Exposure Lending Survey (FFIEC 009).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the latest E16 country-exposure survey, all banks.\nobb.federal_reserve.ffiec.country_exposure(provider='federal_reserve')\n# Get large financial institutions' claims by sector of obligor (Table 4.1) for a single country.\nobb.federal_reserve.ffiec.country_exposure(group='lfi', table='4.1', country='JAPAN', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The report period end date; defaults to the latest release. The survey is quarterly, available ~90 days after the reporting date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "group", + "type": "str | None", + "description": "The reporting group: all banks, large financial institutions (LFI), or all other banks.", + "default": "all_banks", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Banks", + "value": "all_banks" + }, + { + "label": "Large Financial Institutions (LFI)", + "value": "lfi" + }, + { + "label": "All Other Banks", + "value": "all_others" + } + ] + } + } + }, + { + "name": "table", + "type": "str | None", + "description": "The survey table: 1 (ultimate-risk claims + off-balance sheet), 2 (immediate-counterparty claims + risk transfers), 3 (foreign office liabilities), 4.1/4.2 (claims by sector of obligor).", + "default": "1", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Table 1 \u2014 Ultimate-risk claims and off-balance-sheet exposures", + "value": "1" + }, + { + "label": "Table 2 \u2014 Immediate-counterparty claims and risk transfers", + "value": "2" + }, + { + "label": "Table 3 \u2014 Foreign-office liabilities", + "value": "3" + }, + { + "label": "Table 4.1 \u2014 Claims by sector of obligor (ultimate risk)", + "value": "4.1" + }, + { + "label": "Table 4.2 \u2014 Claims by sector of obligor (immediate counterparty)", + "value": "4.2" + } + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Filter to a single country (case-insensitive).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveCountryExposure", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The report period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "group", + "type": "str", + "description": "The reporting group.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "table", + "type": "str", + "description": "The survey table.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country_group", + "type": "str | None", + "description": "The region the country is grouped under.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "The obligor country.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveCountryExposure", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC E.16 Country Exposure (FFIEC 009)", + "description": "The FFIEC E.16 Country Exposure Lending Survey (FFIEC 009) of U.S. banks' foreign claims.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left" + }, + { + "field": "country_group", + "headerName": "Region", + "cellDataType": "text", + "pinned": "left" + }, + { + "field": "country", + "headerName": "Country", + "cellDataType": "text", + "pinned": "left" + } + ] + } + } + }, + "model": "FederalReserveCountryExposure" + } + }, + "/federal_reserve/ffiec/large_holding_companies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the largest US bank holding companies ranked by total assets.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the 25 largest bank holding companies.\nobb.federal_reserve.ffiec.large_holding_companies(limit=25, provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of holding companies returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveLargeHoldingCompanies", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "rank", + "type": "int", + "description": "Rank by total consolidated assets.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rssd_id", + "type": "str", + "description": "The holding company's RSSD identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The holding company's legal name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "location", + "type": "str | None", + "description": "The holding company's headquarters location.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "float | None", + "description": "Total consolidated assets, in USD.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "The reporting period-end date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveLargeHoldingCompanies", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "Largest U.S. Bank Holding Companies", + "description": "The largest U.S. bank holding companies ranked by total consolidated assets. Click an RSSD to drive the bank-condition widgets.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": false, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left" + }, + { + "field": "rank", + "headerName": "Rank", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "rssd_id", + "headerName": "RSSD ID", + "cellDataType": "text", + "formatterFn": "none", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "rssd_id" + } + } + }, + { + "field": "name", + "headerName": "Name", + "cellDataType": "text" + }, + { + "field": "location", + "headerName": "Location", + "cellDataType": "text" + }, + { + "field": "total_assets", + "headerName": "Total Assets ($)", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReserveLargeHoldingCompanies" + } + }, + "/federal_reserve/ffiec/institution_structure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get NIC institution ownership relationships or merger transformations.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get holding-company ownership relationships for an institution.\nobb.federal_reserve.ffiec.institution_structure(rssd_id='1039502', provider='federal_reserve')\n# Get merger/acquisition transformations.\nobb.federal_reserve.ffiec.institution_structure(kind='transformations', rssd_id='1039502', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "kind", + "type": "str | None", + "description": "Hierarchy ownership 'relationships' or merger/acquisition 'transformations'.", + "default": "relationships", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Ownership relationships (hierarchy)", + "value": "relationships" + }, + { + "label": "Transformations (mergers and acquisitions)", + "value": "transformations" + } + ] + } + } + }, + { + "name": "rssd_id", + "type": "str | None", + "description": "Filter to records referencing this RSSD identifier.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveInstitutionStructure", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "offspring_name", + "type": "str | None", + "description": "The name of the offspring (owned/controlled subsidiary).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_name", + "type": "str | None", + "description": "The name of the parent (owner/controller).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "successor_name", + "type": "str | None", + "description": "The name of the successor (survivor).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "predecessor_name", + "type": "str | None", + "description": "The name of the predecessor (non-survivor).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relationship_level", + "type": "str | None", + "description": "Whether the relationship is direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "control_indicator", + "type": "str | None", + "description": "Whether the parent controls the offspring.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_indicator", + "type": "str | None", + "description": "The form of ownership or control.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_equity", + "type": "float | None", + "description": "The parent's percent of equity voting control.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_other", + "type": "float | None", + "description": "The parent's percent of other voting control.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_equity_bracket", + "type": "str | None", + "description": "The bracketed range of the equity percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "regulated_indicator", + "type": "str | None", + "description": "Whether the relationship is regulated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reason_relationship_terminated", + "type": "str | None", + "description": "The reason the relationship was terminated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transformation_type", + "type": "str | None", + "description": "The type of merger/acquisition transformation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accounting_method", + "type": "str | None", + "description": "The accounting method used in the transformation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relationship_established_date", + "type": "date | None", + "description": "The date the relationship was established.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The date the record became effective.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The date the record ceased to be valid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transformation_date", + "type": "date | None", + "description": "The date the transformation became effective.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "offspring_rssd_id", + "type": "str | None", + "description": "The RSSD identifier of the offspring (owned/controlled).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_rssd_id", + "type": "str | None", + "description": "The RSSD identifier of the parent (owner/controller).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "successor_rssd_id", + "type": "str | None", + "description": "The RSSD identifier of the successor (survivor).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "predecessor_rssd_id", + "type": "str | None", + "description": "The RSSD identifier of the predecessor (non-survivor).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveInstitutionStructure", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC NIC Institution Structure", + "description": "NIC ownership relationships and merger/acquisition transformation history for the selected institution (RSSD).", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": false, + "columnsDefs": [ + { + "field": "offspring_name", + "headerName": "Subsidiary", + "cellDataType": "text", + "pinned": "left" + }, + { + "field": "parent_name", + "headerName": "Parent", + "cellDataType": "text", + "pinned": "left" + }, + { + "field": "successor_name", + "headerName": "Successor", + "cellDataType": "text" + }, + { + "field": "predecessor_name", + "headerName": "Predecessor", + "cellDataType": "text" + }, + { + "field": "relationship_level", + "headerName": "Relationship", + "cellDataType": "text" + }, + { + "field": "control_indicator", + "headerName": "Control", + "cellDataType": "text" + }, + { + "field": "percent_equity", + "headerName": "Equity %", + "cellDataType": "number" + }, + { + "field": "equity_indicator", + "headerName": "Basis of Control", + "cellDataType": "text" + }, + { + "field": "percent_equity_bracket", + "headerName": "Equity Range", + "cellDataType": "text" + }, + { + "field": "percent_other", + "headerName": "Other Voting %", + "cellDataType": "number" + }, + { + "field": "regulated_indicator", + "headerName": "Regulated", + "cellDataType": "text" + }, + { + "field": "reason_relationship_terminated", + "headerName": "Termination Reason", + "cellDataType": "text" + }, + { + "field": "transformation_type", + "headerName": "Transformation", + "cellDataType": "text" + }, + { + "field": "accounting_method", + "headerName": "Accounting Method", + "cellDataType": "text" + }, + { + "field": "relationship_established_date", + "headerName": "Established", + "cellDataType": "date" + }, + { + "field": "start_date", + "headerName": "Start", + "cellDataType": "date" + }, + { + "field": "end_date", + "headerName": "End", + "cellDataType": "date" + }, + { + "field": "transformation_date", + "headerName": "Transformation Date", + "cellDataType": "date" + }, + { + "field": "offspring_rssd_id", + "headerName": "Subsidiary RSSD", + "cellDataType": "text", + "formatterFn": "none" + }, + { + "field": "parent_rssd_id", + "headerName": "Parent RSSD", + "cellDataType": "text", + "formatterFn": "none" + }, + { + "field": "successor_rssd_id", + "headerName": "Successor RSSD", + "cellDataType": "text", + "formatterFn": "none" + }, + { + "field": "predecessor_rssd_id", + "headerName": "Predecessor RSSD", + "cellDataType": "text", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveInstitutionStructure" + } + }, + "/federal_reserve/ffiec/bhcpr_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Browse Bank Holding Company Performance Report (BHCPR) peer-group average PDFs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the Peer 1 ($10B and over) BHCPR reports.\nobb.federal_reserve.ffiec.bhcpr_report(peer_group='1', provider='federal_reserve')\n# Get a peer group's reports for a single year.\nobb.federal_reserve.ffiec.bhcpr_report(peer_group='1', year=2024, provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "peer_group", + "type": "str | None", + "description": "The BHCPR peer group, ranked by total consolidated assets.", + "default": "1", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "value": "1", + "options": [ + { + "label": "Peer 1 \u2014 $10B and over", + "value": "1" + }, + { + "label": "Peer 2 \u2014 $3B to $10B", + "value": "2" + }, + { + "label": "Peer 3 \u2014 $1B to $3B", + "value": "3" + }, + { + "label": "Peer 4 \u2014 $500M to $1B", + "value": "4" + }, + { + "label": "Peer 5 \u2014 under $500M", + "value": "5" + }, + { + "label": "Peer 6 \u2014 under $300M (legacy)", + "value": "6" + }, + { + "label": "Peer 9 \u2014 2nd tier and atypical BHCs", + "value": "9" + } + ] + } + } + }, + { + "name": "year", + "type": "int | None", + "description": "The report year. If None, all years are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number", + "value": null, + "options": [ + { + "label": "All Years", + "value": null + }, + { + "label": "2026", + "value": 2026 + }, + { + "label": "2025", + "value": 2025 + }, + { + "label": "2024", + "value": 2024 + }, + { + "label": "2023", + "value": 2023 + }, + { + "label": "2022", + "value": 2022 + }, + { + "label": "2021", + "value": 2021 + }, + { + "label": "2020", + "value": 2020 + }, + { + "label": "2019", + "value": 2019 + }, + { + "label": "2018", + "value": 2018 + }, + { + "label": "2017", + "value": 2017 + }, + { + "label": "2016", + "value": 2016 + }, + { + "label": "2015", + "value": 2015 + }, + { + "label": "2014", + "value": 2014 + }, + { + "label": "2013", + "value": 2013 + }, + { + "label": "2012", + "value": 2012 + }, + { + "label": "2011", + "value": 2011 + }, + { + "label": "2010", + "value": 2010 + }, + { + "label": "2009", + "value": 2009 + }, + { + "label": "2008", + "value": 2008 + }, + { + "label": "2007", + "value": 2007 + }, + { + "label": "2006", + "value": 2006 + }, + { + "label": "2005", + "value": 2005 + }, + { + "label": "2004", + "value": 2004 + }, + { + "label": "2003", + "value": 2003 + }, + { + "label": "2002", + "value": 2002 + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveBhcprReport", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "peer_group", + "type": "int", + "description": "The BHCPR peer group number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int", + "description": "The report year.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "quarter", + "type": "int", + "description": "The report quarter, from 1 to 4.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period_end", + "type": "date", + "description": "The report period-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The report PDF filename.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The report PDF URL.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveBhcprReport", + "openapi_extra": { + "model": "FederalReserveBhcprReport" + } + }, + "/federal_reserve/ffiec/financial_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an institution's FFIEC regulatory financial report by schedule.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get JPMorgan Chase & Co.'s latest FR Y-9C report by RSSD.\nobb.federal_reserve.ffiec.financial_report(rssd_id='1039502', provider='federal_reserve')\n# Get a single schedule of a holding company's FR Y-15 systemic-risk report.\nobb.federal_reserve.ffiec.financial_report(rssd_id='1039502', report_type='FRY15', section='A', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "rssd_id", + "type": "str", + "description": "The reporting institution's RSSD identifier.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "group": "rssd_id" + } + } + }, + { + "name": "report_type", + "type": "str | None", + "description": "The regulatory report to render, by its FFIEC report code. Defaults to the firm's first filed report. Cascades off `rssd_id`.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "report_types", + "optionsParams": { + "rssd_id": "$rssd_id" + }, + "group": "report_type" + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "The report schedule to return. When omitted, every schedule is rendered. Cascades off `report_type`.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "report_sections", + "optionsParams": { + "report_type": "$report_type" + } + } + } + }, + { + "name": "period", + "type": "str | None", + "description": "The reporting period to render, as a `YYYYMMDD` quarter-end. Defaults to the latest available. Cascades off `rssd_id` and `report_type`.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "report_periods", + "optionsParams": { + "rssd_id": "$rssd_id", + "report_type": "$report_type" + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveFinancialReport", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented by the report hierarchy.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a schedule or sub-section header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The MDRM definition of the line item, shown in a hover card.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "The reported value for the selected period; dollar amounts are reported in full U.S. dollars, while rates and counts are as filed.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveFinancialReport", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC Regulatory Financial Report", + "description": "An institution's regulatory financial report (FR Y-9C, FFIEC 101, FFIEC 102, or FR Y-15) rendered in the report's own schedule layout, for the selected reporting period.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360, + "renderFn": "hoverCard", + "renderFnParams": { + "hoverCard": { + "cellField": "label", + "markdown": "{narrative}" + } + } + }, + { + "field": "value", + "headerName": "Value", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "is_header", + "hide": true + }, + { + "field": "narrative", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveFinancialReport" + } + }, + "/federal_reserve/ffiec/financial_report_pdf": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Browse an institution's filed FFIEC regulatory financial reports as PDFs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get JPMorgan Chase & Co.'s filed FR Y-9C report PDFs.\nobb.federal_reserve.ffiec.financial_report_pdf(rssd_id='1039502', provider='federal_reserve')\n# Get a holding company's filed FR Y-15 report PDFs.\nobb.federal_reserve.ffiec.financial_report_pdf(rssd_id='1039502', report_type='FRY15', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "rssd_id", + "type": "str", + "description": "The reporting institution's RSSD identifier.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "group": "rssd_id" + } + } + }, + { + "name": "report_type", + "type": "str | None", + "description": "The regulatory report whose filed PDFs are listed, by its FFIEC report code. When omitted, the latest filed PDF of each report the firm files is listed. Cascades off `rssd_id`.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "report_types", + "optionsParams": { + "rssd_id": "$rssd_id" + }, + "group": "report_type" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveFinancialReportPdf", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "rssd_id", + "type": "str", + "description": "The reporting institution's RSSD identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str", + "description": "The FFIEC report code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int", + "description": "The report year.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "quarter", + "type": "int", + "description": "The report quarter, from 1 to 4.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str", + "description": "The filed-period label.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The filed report PDF URL.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveFinancialReportPdf", + "openapi_extra": { + "model": "FederalReserveFinancialReportPdf" + } + }, + "/federal_reserve/ffiec/bhcpr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a bank holding company's BHCPR performance data by section.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get JPMorgan Chase & Co.'s latest BHCPR performance measures by RSSD.\nobb.federal_reserve.ffiec.bhcpr(rssd_id='1039502', provider='federal_reserve')\n# Get a single BHCPR report section for a holding company.\nobb.federal_reserve.ffiec.bhcpr(rssd_id='1039502', section='Regulatory Capital Components and Ratios', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "rssd_id", + "type": "str", + "description": "The reporting holding company's RSSD identifier.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "group": "rssd_id" + } + } + }, + { + "name": "section", + "type": "str | None", + "description": "The BHCPR report section to return, by its title. When set to 'All Sections' every section is rendered.", + "default": "Summary Ratios", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "bhcpr_sections" + } + } + }, + { + "name": "period", + "type": "str | None", + "description": "The reporting period to render, as a `YYYYMMDD` quarter-end. Defaults to the latest available. Cascades off `rssd_id`.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "bhcpr_periods", + "optionsParams": { + "rssd_id": "$rssd_id" + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveBhcpr", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "label", + "type": "str", + "description": "The line item, indented under its section or sub-header.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_header", + "type": "bool | None", + "description": "Whether the row is a section or sub-header.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "narrative", + "type": "str | None", + "description": "The BHCPR User's Guide definition of the line item, shown in the hover card.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The line item's value type: 'USD' (full dollars), 'percent', 'ratio' (a multiple), or 'number' (a count).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveBhcpr", + "openapi_extra": { + "widget_config": { + "category": "Federal Reserve", + "subCategory": "FFIEC Reports", + "name": "FFIEC Bank Holding Company Performance Report (BHCPR)", + "description": "A bank holding company's BHCPR performance data rendered in the report's own section layout, with the holding-company value, the peer-group average, and the percentile rank for the current period plus the value for each of the four prior-year periods.", + "gridData": { + "w": 50, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "label", + "headerName": "Line Item", + "cellDataType": "text", + "pinned": "left", + "width": 360 + }, + { + "field": "bank", + "headerName": "BHC", + "headerTooltip": "The holding company's value for the current period.", + "cellDataType": "number" + }, + { + "field": "peer", + "headerName": "Peer Group", + "headerTooltip": "The peer-group average for the current period.", + "cellDataType": "number" + }, + { + "field": "percentile", + "headerName": "Percentile", + "headerTooltip": "The holding company's percentile rank within its peer group.", + "cellDataType": "number" + }, + { + "field": "is_header", + "hide": true + } + ] + } + } + }, + "model": "FederalReserveBhcpr" + } + }, + "/federal_reserve/atlanta/gdpnow": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed GDPNow nowcast model track record.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.gdpnow(provider='federal_reserve')\n# Return the latest-release component contributions table.\nobb.federal_reserve.atlanta.gdpnow(table='table_contributions', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The GDPNow table to return: the current-quarter nowcast evolution, the component contributions to the forecast, the change in contributions per release, the latest-release component growth-rate table, the latest-release component contributions table, or the model's historical track record.", + "default": "evolution", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Nowcast Evolution", + "value": "evolution" + }, + { + "label": "Component Contributions", + "value": "contributions" + }, + { + "label": "Change in Contributions", + "value": "change_in_contributions" + }, + { + "label": "Component Growth-Rate Table", + "value": "table" + }, + { + "label": "Component Contributions Table", + "value": "table_contributions" + }, + { + "label": "Track Record", + "value": "track_record" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaGdpNow", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaGdpNow", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed GDPNow", + "description": "GDPNow real GDP nowcast evolution, contributions, and track record.", + "subCategory": "Growth & Activity", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveAtlantaGdpNow" + } + }, + "/federal_reserve/atlanta/wage_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Wage Growth Tracker by cohort.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.wage_growth(provider='federal_reserve')\n# Return the alternative wage-growth measures.\nobb.federal_reserve.atlanta.wage_growth(cut='alternative', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "cut", + "type": "str | None", + "description": "The Wage Growth Tracker breakdown to return.", + "default": "overall", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Overall", + "value": "overall" + }, + { + "label": "Race", + "value": "race" + }, + { + "label": "Education", + "value": "education" + }, + { + "label": "Age", + "value": "age" + }, + { + "label": "Sex", + "value": "sex" + }, + { + "label": "Occupation", + "value": "occupation" + }, + { + "label": "Industry", + "value": "industry" + }, + { + "label": "Census Division", + "value": "census_division" + }, + { + "label": "Full-Time or Part-Time", + "value": "work_status" + }, + { + "label": "Job Switcher", + "value": "job_switcher" + }, + { + "label": "MSA or non-MSA", + "value": "metro" + }, + { + "label": "Average Wage Quartile", + "value": "wage_quartile" + }, + { + "label": "Paid Hourly", + "value": "paid_hourly" + }, + { + "label": "Non-Smoothed", + "value": "non_smoothed" + }, + { + "label": "Distribution", + "value": "distribution" + }, + { + "label": "Zero Changes", + "value": "zero_changes" + }, + { + "label": "Since 1983", + "value": "since_1983" + }, + { + "label": "Weighted", + "value": "weighted" + }, + { + "label": "Alternative", + "value": "alternative" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaWageGrowth", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaWageGrowth", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Wage Growth Tracker", + "description": "Median 12-month wage growth from the CPS, by demographic cut.", + "subCategory": "Wages & Uncertainty", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveAtlantaWageGrowth" + } + }, + "/federal_reserve/atlanta/sticky_cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Sticky-Price CPI series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.sticky_cpi(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "transform", + "type": "str | None", + "description": "The transform to return for every measure: the monthly level, the 1-month annualized percent change, the 3-month annualized rate, or the 12-month percent change.", + "default": "1-month annualized", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Monthly", + "value": "monthly" + }, + { + "label": "1-Month Annualized", + "value": "1-month annualized" + }, + { + "label": "3-Month Annualized Rate", + "value": "3-month annualized" + }, + { + "label": "12-Month", + "value": "12-month" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaStickyCpi", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaStickyCpi", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Sticky-Price CPI", + "description": "Sticky and flexible CPI measures: monthly, annualized, and 12-month.", + "subCategory": "Inflation", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveAtlantaStickyCpi" + } + }, + "/federal_reserve/atlanta/business_inflation_expectations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Business Inflation Expectations survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.business_inflation_expectations(provider='federal_reserve')\n# Return the projected price-factor (discontinued) question.\nobb.federal_reserve.atlanta.business_inflation_expectations(question='price_factors', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "question", + "type": "str | None", + "description": "The Business Inflation Expectations question to return. The first four are the monthly survey's questions (sales levels, profit margins, unit costs, and projected unit costs); the rest are the quarterly long-term inflation, price-change, unit-sales-levels, and projected price-factor (discontinued) questions.", + "default": "costs", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Sales Levels", + "value": "sales" + }, + { + "label": "Profit Margins", + "value": "profit" + }, + { + "label": "Unit Costs", + "value": "costs" + }, + { + "label": "Projected Unit Costs", + "value": "projections" + }, + { + "label": "Long-Term Inflation (Quarterly)", + "value": "long_term_inflation" + }, + { + "label": "Price Change (Quarterly)", + "value": "price_change" + }, + { + "label": "Unit Sales Levels (Quarterly)", + "value": "unit_sales_levels" + }, + { + "label": "Price Factors (Quarterly, Discontinued)", + "value": "price_factors" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaBusinessInflation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaBusinessInflation", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Business Inflation Expectations", + "description": "Firms' inflation, unit-cost, and price-change expectations (BIE survey).", + "subCategory": "Inflation", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveAtlantaBusinessInflation" + } + }, + "/federal_reserve/atlanta/business_uncertainty": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Survey of Business Uncertainty index values.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.business_uncertainty(provider='federal_reserve')\n# Return the discontinued natural-units series.\nobb.federal_reserve.atlanta.business_uncertainty(table='discontinued', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The Survey of Business Uncertainty table to return.", + "default": "index_smoothed", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Index Values (smoothed)", + "value": "index_smoothed" + }, + { + "label": "Index Values (unsmoothed)", + "value": "index_unsmoothed" + }, + { + "label": "Cost & Price Index (Smoothed)", + "value": "cost_price_smoothed" + }, + { + "label": "Cost & Price Index (unsmoothed)", + "value": "cost_price_unsmoothed" + }, + { + "label": "Reallocation measures", + "value": "reallocation" + }, + { + "label": "Distrib. of Exp. Sales Growth", + "value": "expected_sales_distribution" + }, + { + "label": "Realized Growth Rate Indexes", + "value": "realized_growth" + }, + { + "label": "Distrib. of Realized Sales Gr.", + "value": "realized_sales_distribution" + }, + { + "label": "Historical Data for Research", + "value": "historical_research" + }, + { + "label": "Dicontinued Series", + "value": "discontinued" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaBusinessUncertainty", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaBusinessUncertainty", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Survey of Business Uncertainty", + "description": "Monthly firm-level expectations and uncertainty indexes (SBU).", + "subCategory": "Wages & Uncertainty", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveAtlantaBusinessUncertainty" + } + }, + "/federal_reserve/atlanta/market_probability": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Market Probability Tracker series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.market_probability(provider='federal_reserve')\n# Limit to a recent window.\nobb.federal_reserve.atlanta.market_probability(start_date='2026-01-01', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "meeting", + "type": "str | None", + "description": "The reference FOMC meeting date (ISO) whose implied target-rate-range distribution to return. When omitted, the nearest upcoming meeting is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/federal_reserve/market_probability_meetings" + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaMarketProbability", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "target_range", + "type": "str", + "description": "The target federal-funds-rate range label for the bin.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "probability", + "type": "float | None", + "description": "The implied probability for the bin at the selected meeting.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaMarketProbability", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Market Probability Tracker", + "description": "Implied probability distribution across target-rate ranges for a selected upcoming FOMC meeting, latest date.", + "subCategory": "Monetary Policy", + "gridData": { + "w": 40, + "h": 18, + "fullWidth": true + }, + "data": { + "table": { + "showAll": true, + "enableCharts": true, + "chartView": { + "enabled": true, + "chartType": "column" + }, + "columnsDefs": [ + { + "field": "target_range", + "headerName": "Target Rate Range", + "cellDataType": "text", + "pinned": "left" + }, + { + "field": "probability", + "headerName": "Probability", + "cellDataType": "number" + } + ] + } + } + }, + "model": "FederalReserveAtlantaMarketProbability" + } + }, + "/federal_reserve/atlanta/taylor_rule": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Taylor Rule prescribed federal funds rate vs. actual.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.taylor_rule(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaTaylorRule", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The mid-quarter observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "actual_fed_funds_rate", + "type": "float | None", + "description": "The actual federal funds rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "taylor_93_unemployment", + "type": "float | None", + "description": "1993 rule prescription (r*=FOMC median, gap=FOMC U-3 gap, gap weight=0.5).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "taylor_99_unemployment", + "type": "float | None", + "description": "1999 balanced-approach prescription (r*=FOMC median, gap=FOMC U-3 gap, gap weight=1.0).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "taylor_93_gdp", + "type": "float | None", + "description": "1993 rule prescription (r*=LW 1-sided, gap=CBO GDP gap, gap weight=0.5).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaTaylorRule", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Taylor Rule Prescriptions", + "description": "Actual federal funds rate vs. the prescription from three Taylor rule forms.", + "subCategory": "Monetary Policy", + "gridData": { + "w": 40, + "h": 18, + "fullWidth": true + }, + "data": { + "table": { + "showAll": true, + "enableCharts": true, + "chartView": { + "enabled": true, + "chartType": "line" + }, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "actual_fed_funds_rate", + "headerName": "Actual Fed Funds Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "taylor_93_unemployment", + "headerName": "Taylor 1993 (U-3 Gap)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "taylor_99_unemployment", + "headerName": "Taylor 1999 (U-3 Gap)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "taylor_93_gdp", + "headerName": "Taylor 1993 (CBO GDP Gap)", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveAtlantaTaylorRule" + } + }, + "/federal_reserve/atlanta/taylor_rule_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Taylor Rule menu of candidate input measures.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.taylor_rule_measures(provider='federal_reserve')\n# Return the candidate resource-gap measures.\nobb.federal_reserve.atlanta.taylor_rule_measures(measure='gap', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "measure", + "type": "str | None", + "description": "The menu of candidate input measures to return: natural real rate (r*), resource gap, inflation, inflation target, or funds rate.", + "default": "natural_rate", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Natural Real Rate (r*)", + "value": "natural_rate" + }, + { + "label": "Resource Gap", + "value": "gap" + }, + { + "label": "Inflation", + "value": "inflation" + }, + { + "label": "Inflation Target", + "value": "inflation_target" + }, + { + "label": "Federal Funds Rate", + "value": "fed_funds" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaTaylorRuleMeasures", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The mid-quarter observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaTaylorRuleMeasures", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Taylor Rule Input Measures", + "description": "Candidate input series for the Taylor rule, by measure family.", + "subCategory": "Monetary Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveAtlantaTaylorRuleMeasures" + } + }, + "/federal_reserve/atlanta/taylor_rule_heatmap": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Atlanta Fed Taylor Rule quarterly prescription heat map.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.taylor_rule_heatmap(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "quarter", + "type": "str | None", + "description": "Which quarterly heat-map snapshot to return.", + "default": "latest", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Latest Quarter", + "value": "latest" + }, + { + "label": "Previous Quarter", + "value": "previous" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaTaylorRuleHeatmap", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "r_star_measure", + "type": "str", + "description": "The natural-real-rate (r*) measure labeling the row.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaTaylorRuleHeatmap", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Taylor Rule Heat Map", + "description": "Prescribed federal funds rate across the r-star and resource-gap measure grid.", + "subCategory": "Monetary Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "r_star_measure", + "headerName": "r* Measure", + "cellDataType": "text", + "pinned": "left" + }, + { + "field": "U-3 Gap", + "headerName": "U-3 Gap", + "cellDataType": "number", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 2, + "color": "#2166ac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 2, + "max": 3 + }, + "color": "#4393c3", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 3, + "max": 4 + }, + "color": "#92c5de", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 4, + "max": 5 + }, + "color": "#fddbc7", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6 + }, + "color": "#f4a582", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6, + "max": 7 + }, + "color": "#d6604d", + "fill": true + }, + { + "condition": "gte", + "value": 7, + "color": "#b2182b", + "fill": true + } + ] + } + }, + { + "field": "U-3", + "headerName": "U-3", + "cellDataType": "number", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 2, + "color": "#2166ac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 2, + "max": 3 + }, + "color": "#4393c3", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 3, + "max": 4 + }, + "color": "#92c5de", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 4, + "max": 5 + }, + "color": "#fddbc7", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6 + }, + "color": "#f4a582", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6, + "max": 7 + }, + "color": "#d6604d", + "fill": true + }, + { + "condition": "gte", + "value": 7, + "color": "#b2182b", + "fill": true + } + ] + } + }, + { + "field": "U-6", + "headerName": "U-6", + "cellDataType": "number", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 2, + "color": "#2166ac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 2, + "max": 3 + }, + "color": "#4393c3", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 3, + "max": 4 + }, + "color": "#92c5de", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 4, + "max": 5 + }, + "color": "#fddbc7", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6 + }, + "color": "#f4a582", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6, + "max": 7 + }, + "color": "#d6604d", + "fill": true + }, + { + "condition": "gte", + "value": 7, + "color": "#b2182b", + "fill": true + } + ] + } + }, + { + "field": "Emp-Pop", + "headerName": "Emp-Pop", + "cellDataType": "number", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 2, + "color": "#2166ac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 2, + "max": 3 + }, + "color": "#4393c3", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 3, + "max": 4 + }, + "color": "#92c5de", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 4, + "max": 5 + }, + "color": "#fddbc7", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6 + }, + "color": "#f4a582", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6, + "max": 7 + }, + "color": "#d6604d", + "fill": true + }, + { + "condition": "gte", + "value": 7, + "color": "#b2182b", + "fill": true + } + ] + } + }, + { + "field": "ZPOP", + "headerName": "ZPOP", + "cellDataType": "number", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 2, + "color": "#2166ac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 2, + "max": 3 + }, + "color": "#4393c3", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 3, + "max": 4 + }, + "color": "#92c5de", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 4, + "max": 5 + }, + "color": "#fddbc7", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6 + }, + "color": "#f4a582", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6, + "max": 7 + }, + "color": "#d6604d", + "fill": true + }, + { + "condition": "gte", + "value": 7, + "color": "#b2182b", + "fill": true + } + ] + } + }, + { + "field": "GDP", + "headerName": "GDP", + "cellDataType": "number", + "renderFn": "columnColor", + "renderFnParams": { + "colorRules": [ + { + "condition": "lt", + "value": 2, + "color": "#2166ac", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 2, + "max": 3 + }, + "color": "#4393c3", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 3, + "max": 4 + }, + "color": "#92c5de", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 4, + "max": 5 + }, + "color": "#fddbc7", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 5, + "max": 6 + }, + "color": "#f4a582", + "fill": true + }, + { + "condition": "between", + "range": { + "min": 6, + "max": 7 + }, + "color": "#d6604d", + "fill": true + }, + { + "condition": "gte", + "value": 7, + "color": "#b2182b", + "fill": true + } + ] + } + } + ] + } + } + }, + "model": "FederalReserveAtlantaTaylorRuleHeatmap" + } + }, + "/federal_reserve/atlanta/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Atlanta Fed BIE, SBU, and Working Papers PDF archives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.publications(provider='federal_reserve')\n# Index only the Working Papers series.\nobb.federal_reserve.atlanta.publications(series='working_paper', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "FRB Atlanta Working Paper", + "value": "frb_atlanta_working_paper" + }, + { + "label": "Economic Review", + "value": "economic_review" + }, + { + "label": "Policy Hub", + "value": "policy_hub" + }, + { + "label": "FRB Atlanta Community and Economic Development Discussion Paper", + "value": "frb_atlanta_community_and_economic_development_discussion_paper" + }, + { + "label": "Consumer Payments Research Data Reports", + "value": "consumer_payments_research_data_reports" + }, + { + "label": "Workforce Currents", + "value": "workforce_currents" + }, + { + "label": "FRB Atlanta CQER Working Paper", + "value": "frb_atlanta_cqer_working_paper" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaPublications", + "openapi_extra": { + "model": "FederalReserveAtlantaPublications" + } + }, + "/federal_reserve/atlanta/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Atlanta Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.atlanta.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveAtlantaPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveAtlantaPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Atlanta Fed Publication Series", + "description": "The publication series supported by the Atlanta Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveAtlantaPublicationSeries" + } + }, + "/federal_reserve/boston/economic_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get headline New England Economic Indicators from the Boston Fed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.boston.economic_indicators(provider='federal_reserve')\n# Get every state and supersector employment series.\nobb.federal_reserve.boston.economic_indicators(indicator='employment_by_supersector', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "indicator", + "type": "str | None", + "description": "The New England Economic Indicators chart to retrieve. Each chart returns every constituent series, across all geographies and categories, as its own column.", + "default": "payroll_employment", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveBostonEconomicIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveBostonEconomicIndicators", + "openapi_extra": { + "widget_config": { + "name": "Boston Fed New England Economic Indicators", + "description": "New England Economic Indicators across labor, income, price, housing, and trade charts; every series and geography returned as a column.", + "subCategory": "New England Indicators", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveBostonEconomicIndicators" + } + }, + "/federal_reserve/boston/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Boston Fed New England Economic Conditions PDF archive.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.boston.publications(provider='federal_reserve')\n# Index from a start date.\nobb.federal_reserve.boston.publications(start_date='2025-01-01', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Working Papers", + "value": "working_papers" + }, + { + "label": "New England Economic Review", + "value": "new_england_economic_review" + }, + { + "label": "Communities and Banking", + "value": "communities_and_banking" + }, + { + "label": "Regional Review", + "value": "regional_review" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Current Policy Perspectives", + "value": "current_policy_perspectives" + }, + { + "label": "Public Policy Discussion Paper", + "value": "public_policy_discussion_paper" + }, + { + "label": "Supervisory Research and Analysis Working Papers", + "value": "supervisory_research_and_analysis_working_papers" + }, + { + "label": "New England Economic Indicators", + "value": "new_england_economic_indicators" + }, + { + "label": "Fiscal Facts", + "value": "fiscal_facts" + }, + { + "label": "New England Public Policy Center Research Report", + "value": "new_england_public_policy_center_research_report" + }, + { + "label": "Research Data Report", + "value": "research_data_report" + }, + { + "label": "Public Policy Brief", + "value": "public_policy_brief" + }, + { + "label": "New England Public Policy Center Policy Brief", + "value": "new_england_public_policy_center_policy_brief" + }, + { + "label": "New England Community Developments", + "value": "new_england_community_developments" + }, + { + "label": "Public and Community Affairs Discussion Papers", + "value": "public_and_community_affairs_discussion_papers" + }, + { + "label": "Annual Report", + "value": "annual_report" + }, + { + "label": "New England Public Policy Center Working Paper", + "value": "new_england_public_policy_center_working_paper" + }, + { + "label": "New England Public Policy Center Regional Brief", + "value": "new_england_public_policy_center_regional_brief" + }, + { + "label": "Monograph", + "value": "monograph" + }, + { + "label": "New England Public Policy Center Discussion Paper", + "value": "new_england_public_policy_center_discussion_paper" + }, + { + "label": "New England Public Policy Center Policy Reports", + "value": "new_england_public_policy_center_policy_reports" + }, + { + "label": "Supervisory Research and Analysis Notes", + "value": "supervisory_research_and_analysis_notes" + }, + { + "label": "Labor Market Trends", + "value": "labor_market_trends" + }, + { + "label": "Research Report", + "value": "research_report" + }, + { + "label": "Special Report", + "value": "special_report" + }, + { + "label": "New England Public Policy Center Conference Report", + "value": "new_england_public_policy_center_conference_report" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveBostonPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveBostonPublications", + "openapi_extra": { + "model": "FederalReserveBostonPublications" + } + }, + "/federal_reserve/boston/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Boston Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.boston.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveBostonPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveBostonPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Boston Fed Publication Series", + "description": "The publication series supported by the Boston Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveBostonPublicationSeries" + } + }, + "/federal_reserve/chicago/national_activity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed National Activity Index (CFNAI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.national_activity(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoNationalActivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cfnai", + "type": "float | None", + "description": "The CFNAI index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cfnai_ma3", + "type": "float | None", + "description": "The three-month moving average of the CFNAI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diffusion", + "type": "float | None", + "description": "The CFNAI diffusion index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "production_income", + "type": "float | None", + "description": "Production and income contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employment", + "type": "float | None", + "description": "Employment, unemployment, and hours contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumption_housing", + "type": "float | None", + "description": "Personal consumption and housing contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_orders_inventories", + "type": "float | None", + "description": "Sales, orders, and inventories contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoNationalActivity", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed National Activity Index (CFNAI)", + "subCategory": "National Activity & Conditions", + "description": "Monthly index of 85 indicators of U.S. national economic activity, with category contributions; zero is trend growth.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "cfnai", + "headerName": "CFNAI", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "cfnai_ma_3", + "headerName": "CFNAI MA3", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "diffusion", + "headerName": "Diffusion", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "production_income", + "headerName": "Production & Income", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "employment", + "headerName": "Employment", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "consumption_housing", + "headerName": "Consumption & Housing", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "sales_orders_inventories", + "headerName": "Sales, Orders & Inventories", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveChicagoNationalActivity" + } + }, + "/federal_reserve/chicago/financial_conditions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed National Financial Conditions Index (NFCI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.financial_conditions(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoFinancialConditions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The Friday of the observation week.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "nfci", + "type": "float | None", + "description": "The NFCI index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adjusted_nfci", + "type": "float | None", + "description": "The adjusted NFCI (ANFCI), relative to economic conditions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "risk", + "type": "float | None", + "description": "The risk subindex.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credit", + "type": "float | None", + "description": "The credit subindex.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "leverage", + "type": "float | None", + "description": "The leverage subindex.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nonfinancial_leverage", + "type": "float | None", + "description": "The nonfinancial leverage subindex.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoFinancialConditions", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed National Financial Conditions Index (NFCI)", + "subCategory": "National Activity & Conditions", + "description": "Weekly index of U.S. financial conditions with the adjusted ANFCI and risk, credit, and leverage subindexes; zero is average.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "nfci", + "headerName": "NFCI", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "adjusted_nfci", + "headerName": "Adjusted NFCI", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "risk", + "headerName": "Risk", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "credit", + "headerName": "Credit", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "leverage", + "headerName": "Leverage", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "nonfinancial_leverage", + "headerName": "Nonfinancial Leverage", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveChicagoFinancialConditions" + } + }, + "/federal_reserve/chicago/economic_conditions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed Survey of Economic Conditions (CFSEC) diffusion indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.economic_conditions(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "date_basis", + "type": "str | None", + "description": "Index the series by the survey's publication month or by its reference-period end date.", + "default": "publication", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Publication Month", + "value": "publication" + }, + { + "label": "Reference-Period End Date", + "value": "reference" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoEconomicConditions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "activity", + "type": "float | None", + "description": "The overall business activity index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "activity_manufacturing", + "type": "float | None", + "description": "The manufacturing business activity index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "activity_nonmanufacturing", + "type": "float | None", + "description": "The non-manufacturing business activity index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "outlook", + "type": "float | None", + "description": "The outlook for the U.S. economy index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hiring", + "type": "float | None", + "description": "The current hiring index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hiring_expectations", + "type": "float | None", + "description": "The expected hiring index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_spending_expectations", + "type": "float | None", + "description": "The expected capital spending index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "labor_costs", + "type": "float | None", + "description": "The labor cost pressures index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nonlabor_costs", + "type": "float | None", + "description": "The non-labor cost pressures index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoEconomicConditions", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed Survey of Economic Conditions (CFSEC)", + "subCategory": "National Activity & Conditions", + "description": "Monthly Seventh District diffusion indexes of business activity, outlook, hiring, capital spending, and cost pressures.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "activity", + "headerName": "Activity", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "activity_manufacturing", + "headerName": "Activity (Manufacturing)", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "activity_nonmanufacturing", + "headerName": "Activity (Non-Manufacturing)", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "outlook", + "headerName": "Outlook", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "hiring", + "headerName": "Hiring", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "hiring_expectations", + "headerName": "Hiring Expectations", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "capital_spending_expectations", + "headerName": "Capital Spending Expectations", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "labor_costs", + "headerName": "Labor Costs", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "nonlabor_costs", + "headerName": "Non-Labor Costs", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveChicagoEconomicConditions" + } + }, + "/federal_reserve/chicago/retail_trade": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed Advance Retail Trade Summary (CARTS).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.retail_trade(provider='federal_reserve')\n# Get the monthly m/m percent changes with nowcast.\nobb.federal_reserve.chicago.retail_trade(figure='monthly', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "figure", + "type": "str | None", + "description": "The dashboard figure to return: the weekly sales index (``weekly``), the monthly m/m percent changes with nowcast (``monthly``), the latest month's sales and prices snapshot (``current_month``), the latest nowcast contribution breakdown (``nowcast_contributions``), or the nowcast benchmarked against the Census/VISA (``vs_census_visa``) or BEA/CPI (``vs_bea_cpi``) series.", + "default": "weekly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Weekly Sales Index", + "value": "weekly" + }, + { + "label": "Monthly m/m % Change", + "value": "monthly" + }, + { + "label": "Current Month Snapshot", + "value": "current_month" + }, + { + "label": "Nowcast Contributions", + "value": "nowcast_contributions" + }, + { + "label": "Nowcast vs. Census / VISA", + "value": "vs_census_visa" + }, + { + "label": "Nowcast vs. BEA / CPI", + "value": "vs_bea_cpi" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoRetailTrade", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoRetailTrade", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed Advance Retail Trade Summary (CARTS)", + "subCategory": "Retail & Labor", + "description": "Weekly U.S. retail and food services sales index with monthly nowcasts and benchmark comparisons, one column per series.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveChicagoRetailTrade" + } + }, + "/federal_reserve/chicago/labor_market": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed Labor Market Indicators (CFLMI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.labor_market(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The labor-market flow rates, the real-time unemployment-rate nowcast, its component contributions, or its forecast probabilities.", + "default": "rates", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Rates", + "value": "rates" + }, + { + "label": "Chicago Fed Real-Time UR", + "value": "realtime_unemployment" + }, + { + "label": "Real-Time UR Contributions", + "value": "unemployment_contributions" + }, + { + "label": "Real-Time UR Probs", + "value": "unemployment_probabilities" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoLaborMarket", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "release", + "type": "str | None", + "description": "The estimate vintage, where applicable ('advance' or 'final'). Real-time unemployment tables publish two estimates per date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoLaborMarket", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed Labor Market Indicators (CFLMI)", + "subCategory": "Retail & Labor", + "description": "Monthly U.S. labor-market flow rates and the real-time unemployment-rate nowcast, one column per indicator by vintage.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "release", + "headerName": "Release" + } + ] + } + } + }, + "model": "FederalReserveChicagoLaborMarket" + } + }, + "/federal_reserve/chicago/farmland_values": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed AgLetter year-over-year farmland values.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.farmland_values(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoFarmlandValues", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The quarter-end month of the observation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "year_over_year", + "type": "float | None", + "description": "The District year-over-year percent change in farmland values.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "illinois", + "type": "float | None", + "description": "The Illinois year-over-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indiana", + "type": "float | None", + "description": "The Indiana year-over-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "iowa", + "type": "float | None", + "description": "The Iowa year-over-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "wisconsin", + "type": "float | None", + "description": "The Wisconsin year-over-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoFarmlandValues", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed AgLetter Farmland Values", + "subCategory": "Agriculture", + "description": "Quarterly year-over-year percent changes in Seventh District farmland values, in aggregate and by state.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "year_over_year", + "headerName": "District (Y/Y)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "illinois", + "headerName": "Illinois (Y/Y)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "indiana", + "headerName": "Indiana (Y/Y)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "iowa", + "headerName": "Iowa (Y/Y)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "wisconsin", + "headerName": "Wisconsin (Y/Y)", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveChicagoFarmlandValues" + } + }, + "/federal_reserve/chicago/ag_credit_conditions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed AgLetter agricultural credit conditions indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.ag_credit_conditions(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoAgCredit", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The quarter-end month of the observation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "loan_demand_index", + "type": "float | None", + "description": "The loan demand diffusion index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fund_availability_index", + "type": "float | None", + "description": "The fund availability diffusion index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loan_repayment_index", + "type": "float | None", + "description": "The loan repayment rate diffusion index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loan_to_deposit_ratio", + "type": "float | None", + "description": "The average loan-to-deposit ratio, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoAgCredit", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed AgLetter Agricultural Credit Conditions", + "subCategory": "Agriculture", + "description": "Quarterly Seventh District diffusion indexes of farm loan demand, fund availability, and repayment, with the loan-to-deposit ratio.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "loan_demand_index", + "headerName": "Loan Demand Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "fund_availability_index", + "headerName": "Fund Availability Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "loan_repayment_index", + "headerName": "Loan Repayment Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "loan_to_deposit_ratio", + "headerName": "Loan-to-Deposit Ratio", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveChicagoAgCredit" + } + }, + "/federal_reserve/chicago/farm_loan_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed AgLetter new farm loan interest rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.farm_loan_rates(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoFarmLoanRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The quarter-end month of the observation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "operating_loans", + "type": "float | None", + "description": "The average rate on new operating loans, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "feeder_cattle_loans", + "type": "float | None", + "description": "The average rate on new feeder cattle loans, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "farm_real_estate_loans", + "type": "float | None", + "description": "The average rate on new farm real estate loans, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoFarmLoanRates", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed AgLetter New Farm Loan Interest Rates", + "subCategory": "Agriculture", + "description": "Quarterly average interest rates on new Seventh District farm operating, feeder cattle, and real estate loans, in percent.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "operating_loans", + "headerName": "Operating Loans", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "feeder_cattle_loans", + "headerName": "Feeder Cattle Loans", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "farm_real_estate_loans", + "headerName": "Farm Real Estate Loans", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveChicagoFarmLoanRates" + } + }, + "/federal_reserve/chicago/brave_butters_kelley": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed Brave-Butters-Kelley Indexes (BBKI, historical series).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.brave_butters_kelley(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoBraveButtersKelley", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coincident_index", + "type": "float | None", + "description": "The BBK coincident index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "leading_index", + "type": "float | None", + "description": "The BBK leading index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cycle", + "type": "float | None", + "description": "The cyclical component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cycle_leading", + "type": "float | None", + "description": "The leading cyclical component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cycle_lagging", + "type": "float | None", + "description": "The lagging cyclical component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trend", + "type": "float | None", + "description": "The trend component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "irregular", + "type": "float | None", + "description": "The irregular component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "monthly_gdp", + "type": "float | None", + "description": "The monthly GDP growth estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoBraveButtersKelley", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed Brave-Butters-Kelley Indexes (BBKI)", + "subCategory": "National Activity & Conditions", + "description": "Discontinued monthly decomposition of U.S. real GDP growth into trend, cyclical, and irregular components; last observation May 2022.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "coincident_index", + "headerName": "Coincident Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "leading_index", + "headerName": "Leading Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "cycle", + "headerName": "Cycle", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "cycle_leading", + "headerName": "Cycle (Leading)", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "cycle_lagging", + "headerName": "Cycle (Lagging)", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "trend", + "headerName": "Trend", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "irregular", + "headerName": "Irregular", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "monthly_gdp", + "headerName": "Monthly GDP", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveChicagoBraveButtersKelley" + } + }, + "/federal_reserve/chicago/midwest_economy": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Chicago Fed Midwest Economy Index (MEI, historical series).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.midwest_economy(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoMidwestEconomy", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mei", + "type": "float | None", + "description": "The Midwest Economy Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "illinois", + "type": "float | None", + "description": "The Illinois state contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indiana", + "type": "float | None", + "description": "The Indiana state contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "iowa", + "type": "float | None", + "description": "The Iowa state contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "michigan", + "type": "float | None", + "description": "The Michigan state contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "wisconsin", + "type": "float | None", + "description": "The Wisconsin state contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "regional", + "type": "float | None", + "description": "The relative regional MEI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "manufacturing", + "type": "float | None", + "description": "The manufacturing sector contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "construction", + "type": "float | None", + "description": "The construction and mining sector contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services", + "type": "float | None", + "description": "The service sector contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumer", + "type": "float | None", + "description": "The consumer spending sector contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoMidwestEconomy", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed Midwest Economy Index (MEI)", + "subCategory": "National Activity & Conditions", + "description": "Discontinued monthly index of Seventh District nonfarm business activity, by state and sector; last observation May 2021.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "mei", + "headerName": "MEI", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "illinois", + "headerName": "Illinois", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "indiana", + "headerName": "Indiana", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "iowa", + "headerName": "Iowa", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "michigan", + "headerName": "Michigan", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "wisconsin", + "headerName": "Wisconsin", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "regional", + "headerName": "Regional", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "manufacturing", + "headerName": "Manufacturing", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "construction", + "headerName": "Construction & Mining", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "services", + "headerName": "Services", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "consumer", + "headerName": "Consumer Spending", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveChicagoMidwestEconomy" + } + }, + "/federal_reserve/chicago/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Chicago Fed AgLetter, Fed Letter, EP, and Working Paper archives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.publications(provider='federal_reserve')\n# Index only the AgLetter series.\nobb.federal_reserve.chicago.publications(series='agletter', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Working Paper Series", + "value": "working_paper_series" + }, + { + "label": "Chicago Fed Letter", + "value": "chicago_fed_letter" + }, + { + "label": "Economic Perspectives", + "value": "economic_perspectives" + }, + { + "label": "Profitwise", + "value": "profitwise" + }, + { + "label": "Working Paper Series, Macroeconomic Issues", + "value": "working_paper_series_macroeconomic_issues" + }, + { + "label": "Agricultural Letter", + "value": "agricultural_letter" + }, + { + "label": "Working Paper Series, Issues in Financial Regulation", + "value": "working_paper_series_issues_in_financial_regulation" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Working Paper Series, Regional Economic Issues", + "value": "working_paper_series_regional_economic_issues" + }, + { + "label": "Risk Perspectives", + "value": "risk_perspectives" + }, + { + "label": "Policy Discussion Paper Series", + "value": "policy_discussion_paper_series" + }, + { + "label": "Annual Report", + "value": "annual_report" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoPublications", + "openapi_extra": { + "model": "FederalReserveChicagoPublications" + } + }, + "/federal_reserve/chicago/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Chicago Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.chicago.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveChicagoPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveChicagoPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Chicago Fed Publication Series", + "description": "The publication series supported by the Chicago Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveChicagoPublicationSeries" + } + }, + "/federal_reserve/cleveland/inflation_expectations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Cleveland Fed model-based inflation expectations.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# One- and ten-year model-based inflation expectations.\nobb.federal_reserve.cleveland.inflation_expectations(horizon='1,10', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "Model-implied expected inflation by horizon, the model's real interest rate by horizon, or the ten-year decomposition into expected inflation, real risk premium, and inflation risk premium.", + "default": "expected_inflation", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Expected Inflation", + "value": "expected_inflation" + }, + { + "label": "Real Interest Rate", + "value": "real_interest_rate" + }, + { + "label": "Ten-year Expected Chart", + "value": "ten_year_decomposition" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandInflation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The model output month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandInflation", + "openapi_extra": { + "widget_config": { + "name": "Cleveland Fed Inflation Expectations", + "description": "Model-based estimates of expected average annual inflation and the implied real interest rate, by horizon.", + "subCategory": "Inflation Expectations", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveClevelandInflation" + } + }, + "/federal_reserve/cleveland/inflation_nowcast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Cleveland Fed CPI and PCE inflation nowcasts by target period.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.cleveland.inflation_nowcast(provider='federal_reserve')\n# Get the quarterly annualized nowcasts.\nobb.federal_reserve.cleveland.inflation_nowcast(frequency='quarter', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "frequency", + "type": "str | None", + "description": "The nowcast horizon: month-over-month, quarterly annualized, or year-over-year.", + "default": "month", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Month-over-Month", + "value": "month" + }, + { + "label": "Quarterly Annualized", + "value": "quarter" + }, + { + "label": "Year-over-Year", + "value": "year" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandInflationNowcast", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The target period being nowcast.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandInflationNowcast", + "openapi_extra": { + "widget_config": { + "name": "Cleveland Fed Inflation Nowcast", + "description": "Model nowcasts of CPI, core CPI, PCE, and core PCE inflation by target period, alongside the actual figure once released.", + "subCategory": "Inflation Expectations", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveClevelandInflationNowcast" + } + }, + "/federal_reserve/cleveland/median_cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Cleveland Fed Median CPI and 16% Trimmed-Mean CPI series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.cleveland.median_cpi(provider='federal_reserve')\n# Get the full revised median CPI history.\nobb.federal_reserve.cleveland.median_cpi(table='median_cpi', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The headline summary (Median, Trimmed-Mean, CPI, Core, 12-month), or the full revised history of the median CPI, the 16% trimmed-mean CPI, the CPI, or the core CPI.", + "default": "summary", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Summary", + "value": "summary" + }, + { + "label": "Median CPI (Revised History)", + "value": "median_cpi" + }, + { + "label": "16% Trimmed-Mean CPI (Revised History)", + "value": "trimmed_mean" + }, + { + "label": "CPI", + "value": "cpi" + }, + { + "label": "Core CPI", + "value": "core_cpi" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandMedianCpi", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandMedianCpi", + "openapi_extra": { + "widget_config": { + "name": "Cleveland Fed Median CPI", + "description": "Median and 16% trimmed-mean CPI inflation, with headline and core CPI, by series.", + "subCategory": "Median CPI", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveClevelandMedianCpi" + } + }, + "/federal_reserve/cleveland/median_cpi_components": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest Median CPI component distribution by expenditure category.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.cleveland.median_cpi_components(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandMedianCpiComponents", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "component", + "type": "str", + "description": "The CPI expenditure category.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The category's 1-month annualized percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relative_importance", + "type": "float | None", + "description": "The category's normalized relative importance, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cumulative_relative_importance", + "type": "float | None", + "description": "The cumulative relative importance through this category, sorted by price change, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandMedianCpiComponents", + "openapi_extra": { + "widget_config": { + "name": "Cleveland Fed Median CPI Components", + "description": "The latest month's CPI expenditure categories ranked by 1-month annualized price change, with relative importance weights.", + "subCategory": "Median CPI", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "component", + "headerName": "Component", + "pinned": "left" + }, + { + "field": "change", + "headerName": "1-Month Annualized Percent Change", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "relative_importance", + "headerName": "Relative Importance", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "cumulative_relative_importance", + "headerName": "Cumulative Relative Importance", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveClevelandMedianCpiComponents" + } + }, + "/federal_reserve/cleveland/systemic_risk": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Cleveland Fed Systemic Risk Indicator and distance-to-default legs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.cleveland.systemic_risk(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandSystemicRisk", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandSystemicRisk", + "openapi_extra": { + "widget_config": { + "name": "Cleveland Fed Systemic Risk Indicator", + "description": "A daily gauge of U.S. banking-system stress, the average distance to default minus the portfolio distance to default.", + "subCategory": "Financial Risk", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveClevelandSystemicRisk" + } + }, + "/federal_reserve/cleveland/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Cleveland Fed publication PDF archives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.cleveland.publications(provider='federal_reserve')\n# Index a single series from a start date.\nobb.federal_reserve.cleveland.publications(series='working_paper', start_date='2025-01-01', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Economic Commentary", + "value": "economic_commentary" + }, + { + "label": "Working Papers (Old Series)", + "value": "working_papers_old_series" + }, + { + "label": "Working Papers", + "value": "working_papers" + }, + { + "label": "Economic Review", + "value": "economic_review" + }, + { + "label": "Proceedings", + "value": "proceedings" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Forefront", + "value": "forefront" + }, + { + "label": "Policy Discussion Papers", + "value": "policy_discussion_papers" + }, + { + "label": "Annual Report", + "value": "annual_report" + }, + { + "label": "Community Development Publications", + "value": "community_development_publications" + }, + { + "label": "Community Reinvestment Forum", + "value": "community_reinvestment_forum" + }, + { + "label": "Community Reinvestment Report", + "value": "community_reinvestment_report" + }, + { + "label": "Financial Services working paper", + "value": "financial_services_working_paper" + }, + { + "label": "Cleveland Fed Regional Policy Report", + "value": "cleveland_fed_regional_policy_report" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandPublications", + "openapi_extra": { + "model": "FederalReserveClevelandPublications" + } + }, + "/federal_reserve/cleveland/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Cleveland Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.cleveland.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveClevelandPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveClevelandPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Cleveland Fed Publication Series", + "description": "The publication series supported by the Cleveland Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveClevelandPublicationSeries" + } + }, + "/federal_reserve/dallas/manufacturing": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Texas Manufacturing Outlook Survey (TMOS).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.manufacturing(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasManufacturing", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasManufacturing", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Texas Manufacturing Outlook Survey (TMOS)", + "description": "Monthly diffusion indexes for Texas manufacturers, by indicator.", + "subCategory": "Texas Outlook Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasManufacturing" + } + }, + "/federal_reserve/dallas/service_sector": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Texas Service Sector Outlook Survey (TSSOS).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.service_sector(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasServiceSector", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasServiceSector", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Texas Service Sector Outlook Survey (TSSOS)", + "description": "Monthly diffusion indexes for Texas service-sector firms, by indicator.", + "subCategory": "Texas Outlook Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasServiceSector" + } + }, + "/federal_reserve/dallas/retail": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Texas Retail Outlook Survey (TROS).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.retail(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasRetail", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasRetail", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Texas Retail Outlook Survey (TROS)", + "description": "Monthly diffusion indexes and response shares for Texas retailers, by indicator, horizon, and response component.", + "subCategory": "Texas Outlook Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasRetail" + } + }, + "/federal_reserve/dallas/banking_conditions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Banking Conditions Survey (BCS).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.banking_conditions(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasBanking", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey period end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasBanking", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Banking Conditions Survey (BCS)", + "description": "Diffusion indexes of Eleventh District banking conditions, by indicator and horizon.", + "subCategory": "Texas Outlook Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasBanking" + } + }, + "/federal_reserve/dallas/energy_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Energy Survey: indexes, response shares, and prices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.energy_survey(provider='federal_reserve')\n# Get the exploration and production firm group.\nobb.federal_reserve.dallas.energy_survey(firm_group='exploration_production', provider='federal_reserve')\n# Get the full data with response shares, year-over-year.\nobb.federal_reserve.dallas.energy_survey(table='all_data', transform='year_over_year', provider='federal_reserve')\n# Get the oil and gas price-level forecasts.\nobb.federal_reserve.dallas.energy_survey(table='price_forecasts', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The diffusion indexes, the full data including response shares, the oil and gas price expectations, or the price-level forecasts (reference, average, median, range).", + "default": "index", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Diffusion Indexes", + "value": "index" + }, + { + "label": "All Data", + "value": "all_data" + }, + { + "label": "Price Expectations", + "value": "price_expectations" + }, + { + "label": "Price Forecasts", + "value": "price_forecasts" + } + ] + } + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Compare to the prior quarter or to a year ago. Ignored for the price tables.", + "default": "quarter_over_quarter", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Quarter Over Quarter", + "value": "quarter_over_quarter" + }, + { + "label": "Year Over Year", + "value": "year_over_year" + } + ] + } + } + }, + { + "name": "firm_group", + "type": "str | None", + "description": "The respondent firm group: all firms, exploration and production firms, or oilfield services firms. The price forecasts cover all firms only.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Firms", + "value": "all" + }, + { + "label": "E+P Firms", + "value": "exploration_production" + }, + { + "label": "O+G Support Services Firms", + "value": "support_services" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasEnergy", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasEnergy", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Energy Survey", + "description": "Quarterly Eleventh District oil and gas diffusion indexes, response shares, and price forecasts, by indicator.", + "subCategory": "Energy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasEnergy" + } + }, + "/federal_reserve/dallas/trimmed_mean_pce": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Trimmed Mean PCE Inflation Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.trimmed_mean_pce(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasTrimmedMeanPCE", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "one_month", + "type": "float | None", + "description": "The one-month annualized trimmed mean PCE rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "six_month", + "type": "float | None", + "description": "The six-month annualized trimmed mean PCE rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "twelve_month", + "type": "float | None", + "description": "The twelve-month trimmed mean PCE rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasTrimmedMeanPCE", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Trimmed Mean PCE (PCE)", + "description": "Annualized one-, six-, and twelve-month trimmed mean PCE inflation rates.", + "subCategory": "Texas Economy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "one_month", + "headerName": "One-Month", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "six_month", + "headerName": "Six-Month", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "twelve_month", + "headerName": "Twelve-Month", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveDallasTrimmedMeanPCE" + } + }, + "/federal_reserve/dallas/weekly_economic_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Weekly Economic Index (WEI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.weekly_economic_index(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasWeeklyEconomic", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The week-ending observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "wei", + "type": "float | None", + "description": "The Weekly Economic Index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasWeeklyEconomic", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Weekly Economic Index (WEI)", + "description": "The weekly composite index of U.S. real economic activity, scaled to four-quarter GDP growth.", + "subCategory": "Texas Economy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "wei", + "headerName": "WEI", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveDallasWeeklyEconomic" + } + }, + "/federal_reserve/dallas/leading_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Texas Leading Index (TLI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.leading_index(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasLeadingIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "index", + "type": "float | None", + "description": "The Texas Leading Index level (1987 = 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annual_average", + "type": "float | None", + "description": "The annual average index level.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "yoy_change", + "type": "float | None", + "description": "The year-over-year percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dec_dec_change", + "type": "float | None", + "description": "The December-to-December percent change.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasLeadingIndex", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Texas Leading Index (TLI)", + "description": "The Texas Leading Index level (1987 = 100) with its annual average and year-over-year and December-to-December percent changes.", + "subCategory": "Texas Economy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "index", + "headerName": "Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "annual_average", + "headerName": "Annual Average", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "yoy_change", + "headerName": "Year/Year % Change", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "dec_dec_change", + "headerName": "Dec/Dec % Change", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveDallasLeadingIndex" + } + }, + "/federal_reserve/dallas/global_economic_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Database of Global Economic Indicators (DGEI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.global_economic_indicators(provider='federal_reserve')\n# Get global CPI under PPP-GDP weighting.\nobb.federal_reserve.dallas.global_economic_indicators(indicator='cpi', weighting='ppp_gdp', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "indicator", + "type": "str | None", + "description": "The global indicator: real GDP, CPI, core CPI, exports, imports, industrial production, long-term interest rates, the nominal exchange rate, or policy rates.", + "default": "gdp", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Real GDP", + "value": "gdp" + }, + { + "label": "CPI", + "value": "cpi" + }, + { + "label": "Core CPI", + "value": "core_cpi" + }, + { + "label": "Exports", + "value": "exports" + }, + { + "label": "Imports", + "value": "imports" + }, + { + "label": "Industrial Production", + "value": "industrial_production" + }, + { + "label": "Long-Term Interest Rates", + "value": "long_term_rates" + }, + { + "label": "Nominal Exchange Rate", + "value": "nominal_exchange_rate" + }, + { + "label": "Policy Rates", + "value": "policy_rates" + } + ] + } + } + }, + { + "name": "weighting", + "type": "str | None", + "description": "The country-aggregation weighting scheme.", + "default": "world_trade", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "US Trade Weights", + "value": "us_trade" + }, + { + "label": "World Trade Weights", + "value": "world_trade" + }, + { + "label": "PPP GDP Weights", + "value": "ppp_gdp" + }, + { + "label": "Nominal GDP Weights", + "value": "nominal_gdp" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasDgei", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasDgei", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Global Economic Indicators (DGEI)", + "description": "Country-aggregate series for the selected global indicator and weighting scheme, by series.", + "subCategory": "Global Indicators", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasDgei" + } + }, + "/federal_reserve/dallas/global_real_economic_activity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Index of Global Real Economic Activity (IGREA).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.global_real_economic_activity(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasIgrea", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The index value, in percent deviation from trend.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasIgrea", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Index of Global Real Economic Activity (IGREA)", + "description": "The monthly Kilian index of real activity in global industrial-commodity markets.", + "subCategory": "Global Indicators", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "value", + "headerName": "IGREA", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveDallasIgrea" + } + }, + "/federal_reserve/dallas/government_debt": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed par and market value of U.S. government debt.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.government_debt(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasGovernmentDebt", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasGovernmentDebt", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed U.S. Government Debt", + "description": "Monthly par and market value of U.S. federal debt in billions of dollars, by series.", + "subCategory": "Global Indicators", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasGovernmentDebt" + } + }, + "/federal_reserve/dallas/agricultural_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Eleventh District Agricultural Survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.agricultural_survey(provider='federal_reserve')\n# Get reported farmland values.\nobb.federal_reserve.dallas.agricultural_survey(table='land_values', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The survey table: anticipated farm credit conditions, loan demand and lending, interest rates, cash rents, land values, or loan volume.", + "default": "credit", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Farm Credit Conditions", + "value": "credit" + }, + { + "label": "Loan Demand and Lending", + "value": "lending" + }, + { + "label": "Interest Rates", + "value": "interest_rates" + }, + { + "label": "Cash Rents", + "value": "cash_rents" + }, + { + "label": "Land Values", + "value": "land_values" + }, + { + "label": "Loan Volume", + "value": "loan_volume" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasAgSurvey", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasAgSurvey", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Eleventh District Agricultural Survey", + "description": "Quarterly diffusion indexes, response shares, and reported land values from the Eleventh District agricultural survey, by series.", + "subCategory": "Agriculture & Resources", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveDallasAgSurvey" + } + }, + "/federal_reserve/dallas/breakeven_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed Energy Survey oil break-even prices by shale play.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.breakeven_prices(provider='federal_reserve')\n# Get break-even prices to operate existing wells.\nobb.federal_reserve.dallas.breakeven_prices(well_type='existing', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "well_type", + "type": "str | None", + "description": "Break-even price to profitably operate existing wells or to profitably drill new wells.", + "default": "new", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Existing Wells", + "value": "existing" + }, + { + "label": "New Wells", + "value": "new" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasBreakeven", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "play", + "type": "str", + "description": "The shale play or region.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The average break-even WTI price, in dollars per barrel.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasBreakeven", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Energy Survey Oil Break-Even Prices", + "description": "The WTI break-even oil price in dollars per barrel, by major U.S. shale play.", + "subCategory": "Energy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "play", + "headerName": "Play" + }, + { + "field": "value", + "headerName": "Break-Even Price ($/bbl)", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveDallasBreakeven" + } + }, + "/federal_reserve/dallas/gigafactory_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed U.S. gigafactory (battery plant) map.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.gigafactory_map(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "Battery cell and pack plants, or cathode and chemical plants.", + "default": "battery_cells", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Battery Cells", + "value": "battery_cells" + }, + { + "label": "Cathode", + "value": "cathode" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasGigafactory", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "facility_name", + "type": "str | None", + "description": "The facility name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operator", + "type": "str | None", + "description": "The plant operator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "The U.S. state.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "The latitude.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "The longitude.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasGigafactory", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed U.S. Gigafactory Map", + "description": "Geolocated U.S. battery (gigafactory) manufacturing facilities, with operator, state, and coordinates.", + "subCategory": "Agriculture & Resources", + "gridData": { + "w": 40, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "facility_name", + "headerName": "Facility Name", + "pinned": "left" + }, + { + "field": "operator", + "headerName": "Operator" + }, + { + "field": "state", + "headerName": "State" + }, + { + "field": "latitude", + "headerName": "Latitude", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "longitude", + "headerName": "Longitude", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveDallasGigafactory" + } + }, + "/federal_reserve/dallas/lithium_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Dallas Fed U.S. lithium projects map.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.lithium_map(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasLithium", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "project_name", + "type": "str | None", + "description": "The project name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company", + "type": "str | None", + "description": "The developer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "type", + "type": "str | None", + "description": "The lithium resource type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stage", + "type": "str | None", + "description": "The development stage.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "The latitude.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "The longitude.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasLithium", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed U.S. Lithium Projects Map", + "description": "Geolocated U.S. lithium resource projects, with company, resource type, development stage, and coordinates.", + "subCategory": "Agriculture & Resources", + "gridData": { + "w": 40, + "h": 25 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "project_name", + "headerName": "Project Name", + "pinned": "left" + }, + { + "field": "company", + "headerName": "Company" + }, + { + "field": "type", + "headerName": "Type" + }, + { + "field": "stage", + "headerName": "Stage" + }, + { + "field": "latitude", + "headerName": "Latitude", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "longitude", + "headerName": "Longitude", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveDallasLithium" + } + }, + "/federal_reserve/dallas/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Dallas Fed Working Papers and Southwest Economy PDF archives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.publications(provider='federal_reserve')\n# Index only the Working Papers series.\nobb.federal_reserve.dallas.publications(series='working_papers', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Working Papers", + "value": "working_papers" + }, + { + "label": "Globalization Institute Working Papers", + "value": "globalization_institute_working_papers" + }, + { + "label": "Economic and Financial Policy Review", + "value": "economic_and_financial_policy_review" + }, + { + "label": "Economic Letter", + "value": "economic_letter" + }, + { + "label": "Banking and Community Perspectives", + "value": "banking_and_community_perspectives" + }, + { + "label": "Houston Business", + "value": "houston_business" + }, + { + "label": "Proceedings", + "value": "proceedings" + }, + { + "label": "Monograph", + "value": "monograph" + }, + { + "label": "Financial Industry Studies Working Paper", + "value": "financial_industry_studies_working_paper" + }, + { + "label": "Annual Report", + "value": "annual_report" + }, + { + "label": "Annual Report, Globalization and Monetary Policy Institute", + "value": "annual_report_globalization_and_monetary_policy_institute" + }, + { + "label": "Center for Latin America Working Papers", + "value": "center_for_latin_america_working_papers" + }, + { + "label": "Economic Insights", + "value": "economic_insights" + }, + { + "label": "Staff Papers", + "value": "staff_papers" + }, + { + "label": "Financial Insights", + "value": "financial_insights" + }, + { + "label": "Business Frontier", + "value": "business_frontier" + }, + { + "label": "Perspectives", + "value": "perspectives" + }, + { + "label": "Crossroads", + "value": "crossroads" + }, + { + "label": "Vista", + "value": "vista" + }, + { + "label": "Occasional Papers", + "value": "occasional_papers" + }, + { + "label": "Community Outlook", + "value": "community_outlook" + }, + { + "label": "Community Outlook Survey", + "value": "community_outlook_survey" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasPublications", + "openapi_extra": { + "model": "FederalReserveDallasPublications" + } + }, + "/federal_reserve/dallas/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Dallas Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.dallas.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveDallasPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveDallasPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Dallas Fed Publication Series", + "description": "The publication series supported by the Dallas Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveDallasPublicationSeries" + } + }, + "/federal_reserve/kc/financial_stress_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Financial Stress Index (KCFSI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.financial_stress_index(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityFinancialStress", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kcfsi", + "type": "float | None", + "description": "The Kansas City Financial Stress Index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityFinancialStress", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Financial Stress Index (KCFSI)", + "description": "Monthly index of stress in the U.S. financial system; zero is the long-run average and positive values mark above-average stress.", + "subCategory": "Financial & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "kcfsi", + "headerName": "KCFSI", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveKansasCityFinancialStress" + } + }, + "/federal_reserve/kc/risk_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Risk-On/Risk-Off (RORO) Index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.risk_index(provider='federal_reserve')\n# Get the weekly series.\nobb.federal_reserve.kc.risk_index(frequency='weekly', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The observation frequency.", + "default": "daily", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Daily", + "value": "daily" + }, + { + "label": "Weekly", + "value": "weekly" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityRiskIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "roro", + "type": "float | None", + "description": "The composite Risk-On/Risk-Off index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "spreads", + "type": "float | None", + "description": "The standardized credit-spreads component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equities", + "type": "float | None", + "description": "The standardized equities component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liquidity", + "type": "float | None", + "description": "The standardized liquidity component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gold_currency", + "type": "float | None", + "description": "The standardized gold and currency component.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityRiskIndex", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Risk-On/Risk-Off Index (RORO)", + "description": "Composite measure of investor risk appetite and its four standardized components; positive values flag risk-off conditions.", + "subCategory": "Financial & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "roro", + "headerName": "RORO", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "spreads", + "headerName": "Credit Spreads", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "equities", + "headerName": "Equities", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "liquidity", + "headerName": "Liquidity", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "gold_currency", + "headerName": "Gold & Currency", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveKansasCityRiskIndex" + } + }, + "/federal_reserve/kc/policy_rate_uncertainty": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Policy Rate Uncertainty (KCPRU) and skew (KCPRS).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.policy_rate_uncertainty(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityPolicyRateUncertainty", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kcpru", + "type": "float | None", + "description": "The Policy Rate Uncertainty index level (KCPRU).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "kcprs", + "type": "float | None", + "description": "The Policy Rate Uncertainty skew (KCPRS).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityPolicyRateUncertainty", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Policy Rate Uncertainty (KCPRU & KCPRS)", + "description": "Daily option-implied uncertainty (KCPRU) about the expected federal funds rate path and the skew (KCPRS) of that distribution.", + "subCategory": "Financial & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "kcpru", + "headerName": "KCPRU", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "kcprs", + "headerName": "KCPRS", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveKansasCityPolicyRateUncertainty" + } + }, + "/federal_reserve/kc/natural_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City model-based natural rates of interest and unemployment.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.natural_rate(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityNaturalRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rstar", + "type": "float | None", + "description": "The natural rate of interest (r-star) estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rstar_lower", + "type": "float | None", + "description": "The lower bound of the r-star 68% band.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rstar_upper", + "type": "float | None", + "description": "The upper bound of the r-star 68% band.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ustar", + "type": "float | None", + "description": "The natural rate of unemployment (u-star) estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ustar_lower", + "type": "float | None", + "description": "The lower bound of the u-star 68% band.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ustar_upper", + "type": "float | None", + "description": "The upper bound of the u-star 68% band.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityNaturalRate", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Model-Based Natural Rates (r-star & u-star)", + "description": "Monthly model-based estimates of the natural rate of interest (r-star) and the natural rate of unemployment (u-star), with 68% bands.", + "subCategory": "Financial & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "rstar", + "headerName": "r-star", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "rstar_lower", + "headerName": "r-star Lower", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "rstar_upper", + "headerName": "r-star Upper", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ustar", + "headerName": "u-star", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ustar_lower", + "headerName": "u-star Lower", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ustar_upper", + "headerName": "u-star Upper", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveKansasCityNaturalRate" + } + }, + "/federal_reserve/kc/divisional_lmci": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Divisional Labor Market Conditions Indicators.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.divisional_lmci(provider='federal_reserve')\n# Get the momentum indicator.\nobb.federal_reserve.kc.divisional_lmci(indicator='momentum', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "indicator", + "type": "str | None", + "description": "The LMCI indicator to return.", + "default": "level_of_activity", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Level of Activity", + "value": "level_of_activity" + }, + { + "label": "Momentum", + "value": "momentum" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityDivisionalLmci", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityDivisionalLmci", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Divisional Labor Market Conditions (DIV-LMCI)", + "description": "Labor market conditions index by the U.S. and the nine Census divisions, as either the level of activity or its momentum.", + "subCategory": "Financial & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveKansasCityDivisionalLmci" + } + }, + "/federal_reserve/kc/ag_credit_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Fed Tenth District Agricultural Credit Survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.ag_credit_survey(provider='federal_reserve')\n# Get the farm credit condition diffusion indexes.\nobb.federal_reserve.kc.ag_credit_survey(table='credit_conditions', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "Farmland value changes by land class, or the diffusion indexes of farm credit conditions.", + "default": "land_values", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Land Values", + "value": "land_values" + }, + { + "label": "Credit Conditions", + "value": "credit_conditions" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityAgCreditSurvey", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityAgCreditSurvey", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Tenth District Agricultural Credit Survey", + "description": "Quarterly Tenth District farm credit diffusion indexes and farmland value changes by land class, by series.", + "subCategory": "Agricultural Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveKansasCityAgCreditSurvey" + } + }, + "/federal_reserve/kc/ag_interest_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Fed farm loan interest rates by state and loan type.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.ag_interest_rates(provider='federal_reserve')\n# Get fixed real-estate loan rates.\nobb.federal_reserve.kc.ag_interest_rates(rate_type='fixed', loan_type='real_estate', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "rate_type", + "type": "str | None", + "description": "Variable or fixed interest rates.", + "default": "variable", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Variable", + "value": "variable" + }, + { + "label": "Fixed", + "value": "fixed" + } + ] + } + } + }, + { + "name": "loan_type", + "type": "str | None", + "description": "The loan type: operating, intermediate, or real estate.", + "default": "operating", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Operating", + "value": "operating" + }, + { + "label": "Intermediate", + "value": "intermediate" + }, + { + "label": "Real Estate", + "value": "real_estate" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityAgRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityAgRates", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Farm Loan Interest Rates", + "description": "Quarterly average fixed and variable farm loan interest rates by state and district from the Tenth District credit survey.", + "subCategory": "Agricultural Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveKansasCityAgRates" + } + }, + "/federal_reserve/kc/ag_finance_databook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Kansas City Fed Ag Finance Databook commercial-bank lending history.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.ag_finance_databook(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The full coded historical series, or a published Databook table: farm debt at all banks, farm debt at agricultural banks, or agricultural bank performance ratios.", + "default": "historical", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Historical", + "value": "historical" + }, + { + "label": "Farm Debt All Banks", + "value": "farm_debt_all_banks" + }, + { + "label": "Farm Debt Ag Banks", + "value": "farm_debt_ag_banks" + }, + { + "label": "Ag Bank Performance", + "value": "ag_bank_performance" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityAgFinance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityAgFinance", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Ag Finance Databook", + "description": "Quarterly history of agricultural lending at U.S. commercial banks from Call Reports: loan volumes, delinquency shares, and ratios.", + "subCategory": "Agricultural Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveKansasCityAgFinance" + } + }, + "/federal_reserve/kc/ag_terms_of_lending": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the National Survey of Terms of Lending to Farmers history.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.ag_terms_of_lending(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityAgTermsOfLending", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityAgTermsOfLending", + "openapi_extra": { + "widget_config": { + "name": "KC Fed National Survey of Terms of Lending to Farmers", + "description": "Quarterly non-real-estate farm loan volumes, sizes, maturities, and effective interest rates by loan purpose and size.", + "subCategory": "Agricultural Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveKansasCityAgTermsOfLending" + } + }, + "/federal_reserve/kc/ag_district_surveys": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the combined Federal Reserve District Surveys of Ag Credit Conditions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.ag_district_surveys(provider='federal_reserve')\n# Filter to the Chicago district.\nobb.federal_reserve.kc.ag_district_surveys(district='Chicago', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "district", + "type": "str | None", + "description": "Filter to a single Federal Reserve district by name (e.g. Chicago, Dallas, Kansas City, Minneapolis, Richmond, San Francisco).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityAgDistrictSurveys", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityAgDistrictSurveys", + "openapi_extra": { + "widget_config": { + "name": "Federal Reserve District Surveys of Ag Credit Conditions", + "description": "Combined quarterly diffusion indexes of farm loan demand, repayment, fund availability, and farmland values across districts.", + "subCategory": "Agricultural Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveKansasCityAgDistrictSurveys" + } + }, + "/federal_reserve/kc/ag_databook_archived": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the archived (pre-2018) Kansas City Fed Ag Finance Databook tables.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.ag_databook_archived(provider='federal_reserve')\n# Get an interest-rate table from the archived databook.\nobb.federal_reserve.kc.ag_databook_archived(table='afdr_b1', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The archived databook table. Section A tables cover farm debt outstanding, section B interest rates and terms, and section C the condition of agricultural banks.", + "default": "afdr_a1", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Table A.1", + "value": "afdr_a1" + }, + { + "label": "Table A.2", + "value": "afdr_a2" + }, + { + "label": "Table A.3", + "value": "afdr_a3" + }, + { + "label": "Table A.4", + "value": "afdr_a4" + }, + { + "label": "Table A.5", + "value": "afdr_a5" + }, + { + "label": "Table A.6", + "value": "afdr_a6" + }, + { + "label": "Table A.7", + "value": "afdr_a7" + }, + { + "label": "Table A.8", + "value": "afdr_a8" + }, + { + "label": "Table A.9", + "value": "afdr_a9" + }, + { + "label": "Table A.10", + "value": "afdr_a10" + }, + { + "label": "Table A.11", + "value": "afdr_a11" + }, + { + "label": "Table A.12", + "value": "afdr_a12" + }, + { + "label": "Table A.13", + "value": "afdr_a13" + }, + { + "label": "Table A.14", + "value": "afdr_a14" + }, + { + "label": "Table B.1", + "value": "afdr_b1" + }, + { + "label": "Table B.2", + "value": "afdr_b2" + }, + { + "label": "Table B.3", + "value": "afdr_b3" + }, + { + "label": "Table B.4", + "value": "afdr_b4" + }, + { + "label": "Table B.5", + "value": "afdr_b5" + }, + { + "label": "Table B.6", + "value": "afdr_b6" + }, + { + "label": "Table B.7", + "value": "afdr_b7" + }, + { + "label": "Table B.8", + "value": "afdr_b8" + }, + { + "label": "Table B.9", + "value": "afdr_b9" + }, + { + "label": "Table C.1", + "value": "afdr_c1" + }, + { + "label": "Table C.2", + "value": "afdr_c2" + }, + { + "label": "Table C.3", + "value": "afdr_c3" + }, + { + "label": "Table C.4", + "value": "afdr_c4" + }, + { + "label": "Table C.5", + "value": "afdr_c5" + }, + { + "label": "Table C.6", + "value": "afdr_c6" + }, + { + "label": "Table C.7", + "value": "afdr_c7" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityAgDatabookArchived", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation period-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str", + "description": "The observation frequency, either 'annual' or 'quarter'. The archived sheets stack annual averages and quarterly observations, whose year-end and Q4 dates coincide.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "int | None", + "description": "The report section within the sheet (1-based). The detailed survey tables stack several sections that reuse the same row labels under a different, unlabeled statistic; this keeps each one distinct.", + "default": 1, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityAgDatabookArchived", + "openapi_extra": { + "widget_config": { + "name": "KC Fed Archived Ag Finance Databook", + "description": "Discontinued pre-2018 databook: annual and quarterly series on farm debt, lending terms, and the condition of agricultural banks.", + "subCategory": "Agricultural Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "frequency", + "headerName": "Frequency" + }, + { + "field": "section", + "headerName": "Section" + } + ] + } + } + }, + "model": "FederalReserveKansasCityAgDatabookArchived" + } + }, + "/federal_reserve/kc/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Kansas City Fed Agricultural Bulletin PDF archive.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.publications(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Economic Review", + "value": "economic_review" + }, + { + "label": "Proceedings - Economic Policy Symposium - Jackson Hole", + "value": "proceedings_economic_policy_symposium_jackson_hole" + }, + { + "label": "Research Working Paper", + "value": "research_working_paper" + }, + { + "label": "Proceedings \u2013 Rural and Agricultural Conferences", + "value": "proceedings_rural_and_agricultural_conferences" + }, + { + "label": "Main Street Economist", + "value": "main_street_economist" + }, + { + "label": "TEN", + "value": "ten" + }, + { + "label": "Macro Bulletin", + "value": "macro_bulletin" + }, + { + "label": "Payments System Research Briefing", + "value": "payments_system_research_briefing" + }, + { + "label": "Proceedings \u2013 Payments System Research Conferences", + "value": "proceedings_payments_system_research_conferences" + }, + { + "label": "Financial Industry Perspectives", + "value": "financial_industry_perspectives" + }, + { + "label": "Regional Economic Digest", + "value": "regional_economic_digest" + }, + { + "label": "Monograph", + "value": "monograph" + }, + { + "label": "Payments System Research Working Paper", + "value": "payments_system_research_working_paper" + }, + { + "label": "Midwest Economist", + "value": "midwest_economist" + }, + { + "label": "Community Affairs Research Working Paper", + "value": "community_affairs_research_working_paper" + }, + { + "label": "Technical Briefings", + "value": "technical_briefings" + }, + { + "label": "Regional Research Working Paper", + "value": "regional_research_working_paper" + }, + { + "label": "Community Reinvestment", + "value": "community_reinvestment" + }, + { + "label": "Policy Perspectives", + "value": "policy_perspectives" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityPublications", + "openapi_extra": { + "model": "FederalReserveKansasCityPublications" + } + }, + "/federal_reserve/kc/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Kansas City Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.kc.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveKansasCityPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveKansasCityPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Kansas City Fed Publication Series", + "description": "The publication series supported by the Kansas City Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveKansasCityPublicationSeries" + } + }, + "/federal_reserve/minneapolis/business_conditions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Minneapolis Fed Business Conditions Survey diffusion indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.business_conditions(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisBusinessConditions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_flash", + "type": "bool | None", + "description": "Whether the reading is a flash (forecast) estimate rather than a final survey result.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "benefits", + "type": "float | None", + "description": "Diffusion index for benefits costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "input_prices", + "type": "float | None", + "description": "Diffusion index for input prices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_prices", + "type": "float | None", + "description": "Diffusion index for sales prices.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "wages", + "type": "float | None", + "description": "Diffusion index for wages.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment", + "type": "float | None", + "description": "Diffusion index for capital investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "headcount", + "type": "float | None", + "description": "Diffusion index for headcount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hiring", + "type": "float | None", + "description": "Diffusion index for hiring difficulty.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inventories", + "type": "float | None", + "description": "Diffusion index for inventories.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "profits", + "type": "float | None", + "description": "Diffusion index for profits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales", + "type": "float | None", + "description": "Diffusion index for sales revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisBusinessConditions", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Business Conditions Survey", + "description": "Monthly diffusion indexes from the Ninth District business conditions survey, each the net percentage of respondents reporting an increase over the prior three months.", + "subCategory": "Business Conditions", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "is_flash", + "headerName": "Is Flash", + "cellDataType": "boolean" + }, + { + "field": "benefits", + "headerName": "Benefits", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "input_prices", + "headerName": "Input Prices", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "sales_prices", + "headerName": "Sales Prices", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "wages", + "headerName": "Wages", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "investment", + "headerName": "Investment", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "headcount", + "headerName": "Headcount", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "hiring", + "headerName": "Hiring Difficulty", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "inventories", + "headerName": "Inventories", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "profits", + "headerName": "Profits", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "sales", + "headerName": "Sales", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisBusinessConditions" + } + }, + "/federal_reserve/minneapolis/regional_employment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District regional employment indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.regional_employment(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisEmployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisEmployment", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Regional Employment", + "description": "Monthly total nonfarm employment indexed to 100 at the series start for each Ninth District state and the United States.", + "subCategory": "Labor Market", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "MN", + "headerName": "Minnesota", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "MT", + "headerName": "Montana", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "ND", + "headerName": "North Dakota", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "SD", + "headerName": "South Dakota", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "WI", + "headerName": "Wisconsin", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "US", + "headerName": "United States", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisEmployment" + } + }, + "/federal_reserve/minneapolis/regional_unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District regional unemployment rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.regional_unemployment(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisUnemployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisUnemployment", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Unemployment Rate", + "description": "The monthly unemployment rate, in percent, for each Ninth District state and the United States.", + "subCategory": "Labor Market", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "MN", + "headerName": "Minnesota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "MT", + "headerName": "Montana", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ND", + "headerName": "North Dakota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "SD", + "headerName": "South Dakota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "WI", + "headerName": "Wisconsin", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "US", + "headerName": "United States", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisUnemployment" + } + }, + "/federal_reserve/minneapolis/labor_force_participation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District labor force participation rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.labor_force_participation(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisLaborForce", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisLaborForce", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Labor Force Participation", + "description": "The monthly labor force participation rate, in percent, for each Ninth District state and the United States.", + "subCategory": "Labor Market", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "MN", + "headerName": "Minnesota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "MT", + "headerName": "Montana", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ND", + "headerName": "North Dakota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "SD", + "headerName": "South Dakota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "WI", + "headerName": "Wisconsin", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "US", + "headerName": "United States", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisLaborForce" + } + }, + "/federal_reserve/minneapolis/quits_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District quits rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.quits_rate(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisQuitsRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisQuitsRate", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Quits Rate", + "description": "The monthly quits rate, in percent, for each Ninth District state and the United States, smoothed as a trailing three-month average.", + "subCategory": "Labor Market", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "MN", + "headerName": "Minnesota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "MT", + "headerName": "Montana", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ND", + "headerName": "North Dakota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "SD", + "headerName": "South Dakota", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "WI", + "headerName": "Wisconsin", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "US", + "headerName": "United States", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisQuitsRate" + } + }, + "/federal_reserve/minneapolis/regional_gdp": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District regional real GDP indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.regional_gdp(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisGdp", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The start of the observation quarter.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisGdp", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Regional Real GDP", + "description": "Quarterly inflation-adjusted gross domestic product indexed to 100 at the series start for each Ninth District state and the United States.", + "subCategory": "Output & Prices", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "MN", + "headerName": "Minnesota", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "MT", + "headerName": "Montana", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "ND", + "headerName": "North Dakota", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "SD", + "headerName": "South Dakota", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "WI", + "headerName": "Wisconsin", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "US", + "headerName": "United States", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisGdp" + } + }, + "/federal_reserve/minneapolis/regional_cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District regional Consumer Price Index inflation.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.regional_cpi(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisCpi", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisCpi", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Regional CPI Inflation", + "description": "Monthly year-over-year CPI inflation, in percent, for the United States and the Census divisions that overlap the Ninth District, by headline and core measure.", + "subCategory": "Output & Prices", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "CPI-U US", + "headerName": "CPI-U US", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "CPI-U West North Central", + "headerName": "CPI-U West North Central", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "CPI-U Mountain", + "headerName": "CPI-U Mountain", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "Core US", + "headerName": "Core US", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "Core West North Central", + "headerName": "Core West North Central", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "Core Mountain", + "headerName": "Core Mountain", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisCpi" + } + }, + "/federal_reserve/minneapolis/unemployment_claims": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get weekly Minnesota initial and continued unemployment claims.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.unemployment_claims(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisClaims", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The week-ending date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "initial_claims", + "type": "int | None", + "description": "Initial unemployment insurance claims.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "continued_claims", + "type": "int | None", + "description": "Continued unemployment insurance claims.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisClaims", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Minnesota Unemployment Claims", + "description": "Weekly Minnesota initial and continued unemployment-insurance claims, indexed by the week-ending date.", + "subCategory": "Labor Market", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "initial_claims", + "headerName": "Initial Claims", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "continued_claims", + "headerName": "Continued Claims", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisClaims" + } + }, + "/federal_reserve/minneapolis/job_openings_hiring": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Ninth District job opening and hiring rates by state.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.job_openings_hiring(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisJobOpenings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisJobOpenings", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Ninth District Job Openings and Hiring", + "description": "Monthly job opening and hiring rates, in percent, by Ninth District state.", + "subCategory": "Labor Market", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "MN Job Opening Rate", + "headerName": "MN Job Opening Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "MN Hiring Rate", + "headerName": "MN Hiring Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "MT Job Opening Rate", + "headerName": "MT Job Opening Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "MT Hiring Rate", + "headerName": "MT Hiring Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ND Job Opening Rate", + "headerName": "ND Job Opening Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ND Hiring Rate", + "headerName": "ND Hiring Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "SD Job Opening Rate", + "headerName": "SD Job Opening Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "SD Hiring Rate", + "headerName": "SD Hiring Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "WI Job Opening Rate", + "headerName": "WI Job Opening Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "WI Hiring Rate", + "headerName": "WI Hiring Rate", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisJobOpenings" + } + }, + "/federal_reserve/minneapolis/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Minneapolis Fed research and Quarterly Review PDF archives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.publications(provider='federal_reserve')\n# Index only the Working Papers series.\nobb.federal_reserve.minneapolis.publications(series='working_paper', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Staff Report", + "value": "staff_report" + }, + { + "label": "Working Papers", + "value": "working_papers" + }, + { + "label": "Quarterly Review", + "value": "quarterly_review" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Discussion Paper / Institute for Empirical Macroeconomics", + "value": "discussion_paper_institute_for_empirical_macroeconomics" + }, + { + "label": "Opportunity and Inclusive Growth Institute Working Papers", + "value": "opportunity_and_inclusive_growth_institute_working_papers" + }, + { + "label": "Economic Policy Paper", + "value": "economic_policy_paper" + }, + { + "label": "Annual Report", + "value": "annual_report" + }, + { + "label": "Community Affairs Report", + "value": "community_affairs_report" + }, + { + "label": "Center for Indian Country Development series", + "value": "center_for_indian_country_development_series" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisPublications", + "openapi_extra": { + "model": "FederalReserveMinneapolisPublications" + } + }, + "/federal_reserve/minneapolis/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Minneapolis Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.minneapolis.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveMinneapolisPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveMinneapolisPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Minneapolis Fed Publication Series", + "description": "The publication series supported by the Minneapolis Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveMinneapolisPublicationSeries" + } + }, + "/federal_reserve/ny/supply_chain_pressure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Global Supply Chain Pressure Index (GSCPI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.supply_chain_pressure(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkSupplyChain", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "gscpi", + "type": "float | None", + "description": "The Global Supply Chain Pressure Index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkSupplyChain", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Global Supply Chain Pressure Index (GSCPI)", + "description": "Monthly composite of global supply chain conditions, in standard deviations from its historical average.", + "subCategory": "Inflation", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "gscpi", + "headerName": "GSCPI", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveNewYorkSupplyChain" + } + }, + "/federal_reserve/ny/corporate_bond_distress": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Corporate Bond Market Distress Index (CMDI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.corporate_bond_distress(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkCorporateDistress", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The end-of-week (Friday) observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "float | None", + "description": "The aggregate market CMDI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_grade", + "type": "float | None", + "description": "The investment-grade CMDI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_yield", + "type": "float | None", + "description": "The high-yield CMDI.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkCorporateDistress", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Corporate Bond Market Distress Index (CMDI)", + "description": "Weekly index of distress in the U.S. corporate bond market, for the aggregate market and the IG and HY segments.", + "subCategory": "Household & Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "market", + "headerName": "Market", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "investment_grade", + "headerName": "Investment Grade", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "high_yield", + "headerName": "High Yield", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveNewYorkCorporateDistress" + } + }, + "/federal_reserve/ny/consumer_expectations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Survey of Consumer Expectations across all topics.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.consumer_expectations(provider='federal_reserve')\n# Get expected credit availability by respondent demographics.\nobb.federal_reserve.ny.consumer_expectations(topic='credit_availability', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "topic", + "type": "str | None", + "description": "The survey topic sheet. Topics ending in '_demo' break the series down by respondent demographics; '_distr' topics give the distribution of responses.", + "default": "inflation_expectations", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Inflation Expectations", + "value": "inflation_expectations" + }, + { + "label": "Inflation Expectations (Demographics)", + "value": "inflation_expectations_demo" + }, + { + "label": "Inflation Uncertainty", + "value": "inflation_uncertainty" + }, + { + "label": "Inflation Uncertainty (Demographics)", + "value": "inflation_uncertainty_demo" + }, + { + "label": "Home Price Expectations", + "value": "home_price_expectations" + }, + { + "label": "Home Price Expectations (Demographics)", + "value": "home_price_expectations_demo" + }, + { + "label": "Home Price Uncertainty", + "value": "home_price_uncertainty" + }, + { + "label": "Home Price Uncertainty (Demographics)", + "value": "home_price_uncertainty_demo" + }, + { + "label": "Commodity Expectations", + "value": "commodity_expectations" + }, + { + "label": "Earnings Growth", + "value": "earnings_growth" + }, + { + "label": "Earnings Growth (Demographics)", + "value": "earnings_growth_demo" + }, + { + "label": "Earnings Uncertainty", + "value": "earnings_uncertainty" + }, + { + "label": "Earnings Uncertainty (Demographics)", + "value": "earnings_uncertainty_demo" + }, + { + "label": "Job Separation Expectation", + "value": "job_separation_expectation" + }, + { + "label": "Job Separation Expectation (Demographics)", + "value": "job_separation_expectation_demo" + }, + { + "label": "Job Finding Expectations", + "value": "job_finding_expectations" + }, + { + "label": "Job Finding Expectations (Demographics)", + "value": "job_finding_expectations_demo" + }, + { + "label": "Moving Expectations", + "value": "moving_expectations" + }, + { + "label": "Moving Expectations (Demographics)", + "value": "moving_expectations_demo" + }, + { + "label": "Unemployment Expectations", + "value": "unemployment_expectations" + }, + { + "label": "Unemployment Expectations (Demographics)", + "value": "unemployment_expectations_demo" + }, + { + "label": "Hh Income Change", + "value": "hh_income_change" + }, + { + "label": "Hh Income Change (Demographics)", + "value": "hh_income_change_demo" + }, + { + "label": "Hh Spending Change", + "value": "hh_spending_change" + }, + { + "label": "Hh Spending Change (Demographics)", + "value": "hh_spending_change_demo" + }, + { + "label": "Taxes Change", + "value": "taxes_change" + }, + { + "label": "Taxes Change (Demographics)", + "value": "taxes_change_demo" + }, + { + "label": "Credit Availability", + "value": "credit_availability" + }, + { + "label": "Household Financial Situation", + "value": "household_financial_situation" + }, + { + "label": "Delinquency Expectations", + "value": "delinquency_expectations" + }, + { + "label": "Delinquency Expectations (Demographics)", + "value": "delinquency_expectations_demo" + }, + { + "label": "Interest Rate Expectations", + "value": "interest_rate_expectations" + }, + { + "label": "Interest Rate Expectations (Demographics)", + "value": "interest_rate_expectations_demo" + }, + { + "label": "Stock Prices", + "value": "stock_prices" + }, + { + "label": "Stock Prices (Demographics)", + "value": "stock_prices_demo" + }, + { + "label": "Government Debt", + "value": "government_debt" + }, + { + "label": "Government Debt (Demographics)", + "value": "government_debt_demo" + }, + { + "label": "Inflation Expectations Distr", + "value": "inflation_expectations_distr" + }, + { + "label": "Prob of Infl Outcome", + "value": "prob_of_infl_outcome" + }, + { + "label": "Prob of Infl Outcome (Demographics)", + "value": "prob_of_infl_outcome_demo" + }, + { + "label": "Five Year Ahead Infl Exp", + "value": "five_year_ahead_infl_exp" + }, + { + "label": "Five Year Ahead Infl Exp (Demographics)", + "value": "five_year_ahead_infl_exp_demo" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkConsumerExpectations", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkConsumerExpectations", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Survey of Consumer Expectations (SCE)", + "description": "Monthly Survey of Consumer Expectations results, one column per series, for the selected topic sheet.", + "subCategory": "Consumer Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveNewYorkConsumerExpectations" + } + }, + "/federal_reserve/ny/business_leaders": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Business Leaders Survey diffusion indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.business_leaders(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkBusinessLeaders", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "current", + "type": "float | None", + "description": "The current business activity diffusion index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expected", + "type": "float | None", + "description": "The six-month-ahead expected business activity diffusion index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkBusinessLeaders", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Business Leaders Survey", + "description": "Monthly diffusion indexes of current and six-month-ahead expected business activity for regional service-sector firms.", + "subCategory": "Business Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "current", + "headerName": "Current", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "expected", + "headerName": "Expected", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveNewYorkBusinessLeaders" + } + }, + "/federal_reserve/ny/empire_state_manufacturing": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Empire State Manufacturing Survey diffusion indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.empire_state_manufacturing(provider='federal_reserve')\n# Get the up / down / same response shares behind each index.\nobb.federal_reserve.ny.empire_state_manufacturing(dataset='seasonally_adjusted_all_series', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "dataset", + "type": "str | None", + "description": "The published file to retrieve. The '_diffusion' files give one diffusion index per indicator; the '_all_series' files add the up / down / same response shares behind each index.", + "default": "seasonally_adjusted_diffusion", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Seasonally Adjusted Diffusion", + "value": "seasonally_adjusted_diffusion" + }, + { + "label": "Not Seasonally Adjusted Diffusion", + "value": "not_seasonally_adjusted_diffusion" + }, + { + "label": "Seasonally Adjusted All Series", + "value": "seasonally_adjusted_all_series" + }, + { + "label": "Not Seasonally Adjusted All Series", + "value": "not_seasonally_adjusted_all_series" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkEmpireState", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month, as the month-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkEmpireState", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Empire State Manufacturing Survey", + "description": "Monthly diffusion indexes and response shares for the Empire State Manufacturing Survey, one column per indicator-horizon-measure series.", + "subCategory": "Business Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveNewYorkEmpireState" + } + }, + "/federal_reserve/ny/consumer_labor_market": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed SCE Labor Market Survey reservation wage.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.consumer_labor_market(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkConsumerLaborMarket", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "average_reservation_wage", + "type": "float | None", + "description": "The average reservation wage, in U.S. dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkConsumerLaborMarket", + "openapi_extra": { + "widget_config": { + "name": "NY Fed SCE Labor Market Survey \u2014 Reservation Wage", + "description": "Average reservation wage from the triannual SCE Labor Market Survey, in U.S. dollars.", + "subCategory": "Consumer Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "average_reservation_wage", + "headerName": "Average Reservation Wage", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveNewYorkConsumerLaborMarket" + } + }, + "/federal_reserve/ny/consumer_housing": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed SCE Housing Survey across all topics.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.consumer_housing(provider='federal_reserve')\n# Get expected mortgage rate perceptions by demographics.\nobb.federal_reserve.ny.consumer_housing(topic='rate_perceptions_demo', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "topic", + "type": "str | None", + "description": "The housing survey topic sheet. Topics ending in '_demo' break the series down by respondent demographics; '_distr' topics give the distribution of responses.", + "default": "home_price_expectations", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Home Price Expectations", + "value": "home_price_expectations" + }, + { + "label": "Home Price Expectations (Demographics)", + "value": "home_price_expectations_demo" + }, + { + "label": "Home Price Change Distr", + "value": "home_price_change_distr" + }, + { + "label": "Home Price Change Distr (Demographics)", + "value": "home_price_change_distr_demo" + }, + { + "label": "Rent Change Expectations", + "value": "rent_change_expectations" + }, + { + "label": "Rent Change Expectations (Demographics)", + "value": "rent_change_expectations_demo" + }, + { + "label": "Housing As Investment", + "value": "housing_as_investment" + }, + { + "label": "Housing As Investment (Demographics)", + "value": "housing_as_investment_demo" + }, + { + "label": "Probability of Moving", + "value": "probability_of_moving" + }, + { + "label": "Probability of Moving (Demographics)", + "value": "probability_of_moving_demo" + }, + { + "label": "Probability of Buying", + "value": "probability_of_buying" + }, + { + "label": "Probability of Buying (Demographics)", + "value": "probability_of_buying_demo" + }, + { + "label": "Rate Perceptions", + "value": "rate_perceptions" + }, + { + "label": "Rate Perceptions (Demographics)", + "value": "rate_perceptions_demo" + }, + { + "label": "Rate Expectations", + "value": "rate_expectations" + }, + { + "label": "Rate Expectations (Demographics)", + "value": "rate_expectations_demo" + }, + { + "label": "Rate Distribution", + "value": "rate_distribution" + }, + { + "label": "Rate Distribution (Demographics)", + "value": "rate_distribution_demo" + }, + { + "label": "Probability of Refinancing", + "value": "probability_of_refinancing" + }, + { + "label": "Probability of Refinancing (Demographics)", + "value": "probability_of_refinancing_demo" + }, + { + "label": "Prob of Home Investments", + "value": "prob_of_home_investments" + }, + { + "label": "Prob of Home Investments (Demographics)", + "value": "prob_of_home_investments_demo" + }, + { + "label": "Home Tenure Expectations", + "value": "home_tenure_expectations" + }, + { + "label": "Home Tenure Expectations (Demographics)", + "value": "home_tenure_expectations_demo" + }, + { + "label": "Ease of Obtaining Mortgage", + "value": "ease_of_obtaining_mortgage" + }, + { + "label": "Ease of Obtaining Mortgage (Demographics)", + "value": "ease_of_obtaining_mortgage_demo" + }, + { + "label": "Preference for Owning", + "value": "preference_for_owning" + }, + { + "label": "Preference for Owning (Demographics)", + "value": "preference_for_owning_demo" + }, + { + "label": "Renters Prob of Buying", + "value": "renters_prob_of_buying" + }, + { + "label": "Renters Prob of Buying (Demographics)", + "value": "renters_prob_of_buying_demo" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkConsumerHousing", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkConsumerHousing", + "openapi_extra": { + "widget_config": { + "name": "NY Fed SCE Housing Survey", + "description": "Annual SCE Housing Survey results, one column per series, for the selected topic sheet.", + "subCategory": "Consumer Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveNewYorkConsumerHousing" + } + }, + "/federal_reserve/ny/consumer_credit_access": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed SCE Credit Access Survey across all metrics.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.consumer_credit_access(provider='federal_reserve')\n# Get the breakdown by age and credit-score group.\nobb.federal_reserve.ny.consumer_credit_access(breakdown='demographics', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "breakdown", + "type": "str | None", + "description": "The overall (all respondents) series, or the breakdown by respondent age and credit-score group.", + "default": "overall", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Overall", + "value": "overall" + }, + { + "label": "Demographics", + "value": "demographics" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkConsumerCreditAccess", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "group", + "type": "str | None", + "description": "The respondent grouping.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "The respondent category.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkConsumerCreditAccess", + "openapi_extra": { + "widget_config": { + "name": "NY Fed SCE Credit Access Survey", + "description": "Triannual SCE Credit Access Survey application, acceptance, rejection, and expectation series, one column per series, by respondent group and category.", + "subCategory": "Consumer Surveys", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "group", + "headerName": "Group" + }, + { + "field": "category", + "headerName": "Category" + } + ] + } + } + }, + "model": "FederalReserveNewYorkConsumerCreditAccess" + } + }, + "/federal_reserve/ny/household_debt": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed total household debt balance by category.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.household_debt(provider='federal_reserve')\n# Get the by-state composition of debt balance per capita.\nobb.federal_reserve.ny.household_debt(table='composition_of_debt_balance_per_capita_by_state', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The report table to retrieve. Each table corresponds to one chart in the Quarterly Report on Household Debt and Credit, including national, by-age, and by-state breakdowns.", + "default": "total_debt_balance", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Total Debt Balance", + "value": "total_debt_balance" + }, + { + "label": "Number of Accounts by Loan Type", + "value": "number_of_accounts_by_loan_type" + }, + { + "label": "New and Closed Accounts and Inquiries", + "value": "new_and_closed_accounts_and_inquiries" + }, + { + "label": "Mortgage Originations by Credit Score", + "value": "mortgage_originations_by_credit_score" + }, + { + "label": "Credit Score at Origination Mortgages", + "value": "credit_score_at_origination_mortgages" + }, + { + "label": "Auto Loan Originations by Credit Score", + "value": "auto_loan_originations_by_credit_score" + }, + { + "label": "Credit Score at Origination Auto Loans", + "value": "credit_score_at_origination_auto_loans" + }, + { + "label": "Credit Limit and Balance Cards and He Revolving", + "value": "credit_limit_and_balance_cards_and_he_revolving" + }, + { + "label": "Total Balance by Delinquency Status", + "value": "total_balance_by_delinquency_status" + }, + { + "label": "Percent of Balance 90 Days Delinquent by Loan Type", + "value": "percent_of_balance_90_days_delinquent_by_loan_type" + }, + { + "label": "Flow Into Early Delinquency by Loan Type", + "value": "flow_into_early_delinquency_by_loan_type" + }, + { + "label": "Flow Into Serious Delinquency by Loan Type", + "value": "flow_into_serious_delinquency_by_loan_type" + }, + { + "label": "Transition Rates Current Mortgage Accounts", + "value": "transition_rates_current_mortgage_accounts" + }, + { + "label": "Transition Rates 30 60 Day Late Mortgage Accounts", + "value": "transition_rates_30_60_day_late_mortgage_accounts" + }, + { + "label": "New Foreclosures and Bankruptcies", + "value": "new_foreclosures_and_bankruptcies" + }, + { + "label": "Third Party Collections", + "value": "third_party_collections" + }, + { + "label": "Total Debt Balance by Age", + "value": "total_debt_balance_by_age" + }, + { + "label": "Debt Share by Product Type and Age", + "value": "debt_share_by_product_type_and_age" + }, + { + "label": "Auto Loan Originations by Age", + "value": "auto_loan_originations_by_age" + }, + { + "label": "Mortgage Originations by Age", + "value": "mortgage_originations_by_age" + }, + { + "label": "Transition Into Serious Delinquency by Age", + "value": "transition_into_serious_delinquency_by_age" + }, + { + "label": "Transition Into Serious Delinquency Mortgages by Age", + "value": "transition_into_serious_delinquency_mortgages_by_age" + }, + { + "label": "Transition Into Serious Delinquency Auto Loans by Age", + "value": "transition_into_serious_delinquency_auto_loans_by_age" + }, + { + "label": "Transition Into Serious Delinquency Credit Cards by Age", + "value": "transition_into_serious_delinquency_credit_cards_by_age" + }, + { + "label": "Transition Into Serious Delinquency Student Loans by Age", + "value": "transition_into_serious_delinquency_student_loans_by_age" + }, + { + "label": "New Foreclosures by Age", + "value": "new_foreclosures_by_age" + }, + { + "label": "New Bankruptcies by Age", + "value": "new_bankruptcies_by_age" + }, + { + "label": "Composition of Debt Balance per Capita by State", + "value": "composition_of_debt_balance_per_capita_by_state" + }, + { + "label": "Delinquency Status per Capita by State Recent", + "value": "delinquency_status_per_capita_by_state_recent" + }, + { + "label": "Delinquency Status per Capita by State Prior", + "value": "delinquency_status_per_capita_by_state_prior" + }, + { + "label": "Percent of Balance 90 Days Late by State", + "value": "percent_of_balance_90_days_late_by_state" + }, + { + "label": "Percent of Mortgage Debt 90 Days Late by State", + "value": "percent_of_mortgage_debt_90_days_late_by_state" + }, + { + "label": "Transition Rates Into 30 Days Late by State", + "value": "transition_rates_into_30_days_late_by_state" + }, + { + "label": "Transition Rates Into 90 Days Late by State", + "value": "transition_rates_into_90_days_late_by_state" + }, + { + "label": "Percent of Consumers With New Foreclosures by State", + "value": "percent_of_consumers_with_new_foreclosures_by_state" + }, + { + "label": "Percent of Consumers With New Bankruptcies by State", + "value": "percent_of_consumers_with_new_bankruptcies_by_state" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkHouseholdDebt", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The quarter, as the quarter-end date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkHouseholdDebt", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Household Debt and Credit", + "description": "Quarterly Report on Household Debt and Credit, one column per series, for the selected report table.", + "subCategory": "Household & Credit", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveNewYorkHouseholdDebt" + } + }, + "/federal_reserve/ny/core_trend_inflation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Multivariate Core Trend (MCT) inflation estimate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.core_trend_inflation(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkCoreTrendInflation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The reference month, as the month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mct", + "type": "float | None", + "description": "The Multivariate Core Trend inflation estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mct_upper", + "type": "float | None", + "description": "The upper uncertainty band of the MCT estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mct_upper_2", + "type": "float | None", + "description": "The outer upper uncertainty band of the MCT estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mct_lower", + "type": "float | None", + "description": "The lower uncertainty band of the MCT estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "headline_pce", + "type": "float | None", + "description": "Year-over-year headline PCE inflation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "core_pce", + "type": "float | None", + "description": "Year-over-year core PCE inflation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods", + "type": "float | None", + "description": "The goods sector contribution to trend inflation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_ex_housing", + "type": "float | None", + "description": "The services-ex-housing contribution to trend inflation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "housing", + "type": "float | None", + "description": "The housing contribution to trend inflation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods_common", + "type": "float | None", + "description": "The common component of the goods sector contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goods_sector_specific", + "type": "float | None", + "description": "The sector-specific component of the goods sector contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_ex_housing_common", + "type": "float | None", + "description": "The common component of the services-ex-housing contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "services_ex_housing_sector_specific", + "type": "float | None", + "description": "The sector-specific component of the services-ex-housing contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "housing_common", + "type": "float | None", + "description": "The common component of the housing contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "housing_sector_specific", + "type": "float | None", + "description": "The sector-specific component of the housing contribution.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkCoreTrendInflation", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Multivariate Core Trend (MCT) Inflation", + "description": "Monthly model-based estimate of core PCE trend inflation, with uncertainty bands and the sector decomposition, in annualized percent.", + "subCategory": "Inflation", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "mct", + "headerName": "MCT", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "mct_upper", + "headerName": "MCT Upper", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "mct_upper_2", + "headerName": "MCT Upper (Outer)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "mct_lower", + "headerName": "MCT Lower", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "headline_pce", + "headerName": "Headline PCE", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "core_pce", + "headerName": "Core PCE", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "goods", + "headerName": "Goods", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "services_ex_housing", + "headerName": "Services ex-Housing", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "housing", + "headerName": "Housing", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "goods_common", + "headerName": "Goods (Common)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "goods_sector_specific", + "headerName": "Goods (Sector-Specific)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "services_ex_housing_common", + "headerName": "Services ex-Housing (Common)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "services_ex_housing_sector_specific", + "headerName": "Services ex-Housing (Sector-Specific)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "housing_common", + "headerName": "Housing (Common)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "housing_sector_specific", + "headerName": "Housing (Sector-Specific)", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveNewYorkCoreTrendInflation" + } + }, + "/federal_reserve/ny/empire_state_reports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the New York Fed Empire State Survey monthly report PDF archive.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.empire_state_reports(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkEmpireReports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month, as the month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The report period as ``YYYYMM``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the PDF document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkEmpireReports", + "openapi_extra": { + "model": "FederalReserveNewYorkEmpireReports" + } + }, + "/federal_reserve/ny/market_expectations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Survey of Market Expectations results data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.market_expectations(provider='federal_reserve')\n# Return only the combined panel.\nobb.federal_reserve.ny.market_expectations(panel_type='Combined', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "panel_type", + "type": "str | None", + "description": "Filter to a single respondent panel.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Combined", + "value": "Combined" + }, + { + "label": "Primary Dealers", + "value": "Dealer" + }, + { + "label": "Market Participants", + "value": "Participant" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkMarketExpectations", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey release date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "survey_due_date", + "type": "date | None", + "description": "The date responses were due.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "panel_type", + "type": "str | None", + "description": "The respondent panel: 'Combined', 'Dealer', or 'Participant'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "question_number", + "type": "str | None", + "description": "The survey question number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "theme", + "type": "str | None", + "description": "The question theme.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subject_group", + "type": "str | None", + "description": "The question subject group.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subject", + "type": "str | None", + "description": "The question subject.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "question_type", + "type": "str | None", + "description": "The question type, e.g. 'probability' or 'point'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "question_mode", + "type": "str | None", + "description": "The question mode, e.g. 'levels' or 'change'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "question_text", + "type": "str | None", + "description": "The full question text.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "question_tag", + "type": "str | None", + "description": "The machine-readable question identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value_tag", + "type": "str | None", + "description": "The machine-readable value identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "top_header_value", + "type": "str | None", + "description": "The top header label for a matrix question cell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "left_header_value", + "type": "str | None", + "description": "The left header label for a matrix question cell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon", + "type": "str | None", + "description": "The forecast horizon, e.g. '6months'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon_date", + "type": "date | None", + "description": "The date the horizon resolves to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bucket_range", + "type": "str | None", + "description": "The response bucket range label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bucket_low", + "type": "float | None", + "description": "The lower bound of the response bucket.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bucket_high", + "type": "float | None", + "description": "The upper bound of the response bucket.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "aggregation", + "type": "str | None", + "description": "The aggregation statistic, e.g. 'avg', 'count', or 'pctl50'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "aggregation_value", + "type": "float | None", + "description": "The aggregated response value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkMarketExpectations", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Survey of Market Expectations", + "description": "Machine-readable results of the pre-FOMC Surveys of Primary Dealers and Market Participants - aggregated responses by question, panel, and horizon.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 50, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "panel_type", + "headerName": "Panel" + }, + { + "field": "question_number", + "headerName": "Q#" + }, + { + "field": "subject", + "headerName": "Subject" + }, + { + "field": "question_text", + "headerName": "Question" + }, + { + "field": "horizon", + "headerName": "Horizon" + }, + { + "field": "aggregation", + "headerName": "Statistic" + }, + { + "field": "aggregation_value", + "headerName": "Value", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveNewYorkMarketExpectations" + } + }, + "/federal_reserve/ny/market_expectations_reports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the New York Fed Survey of Market Expectations PDF archive.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.market_expectations_reports(provider='federal_reserve')\n# Index only the results reports.\nobb.federal_reserve.ny.market_expectations_reports(kind='results', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str | None", + "description": "Filter the catalog by document kind.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Results", + "value": "results" + }, + { + "label": "Questionnaire", + "value": "questionnaire" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkMarketExpectationsReports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str", + "description": "The document kind, 'results' or 'questionnaire'.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "subtype", + "type": "str", + "description": "The respondent panel: 'combined', 'primary_dealers', or 'market_participants'.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the PDF document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkMarketExpectationsReports", + "openapi_extra": { + "model": "FederalReserveNewYorkMarketExpectationsReports" + } + }, + "/federal_reserve/ny/nowcast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the New York Fed Staff Nowcast of U.S. real GDP growth.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.nowcast(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkNowcast", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The forecast vintage date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "reference_quarter", + "type": "str", + "description": "The reference quarter the estimates describe, as ``YYYY:QN``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "backcast", + "type": "float | None", + "description": "Real GDP growth backcast for the previous quarter, annualized percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nowcast", + "type": "float | None", + "description": "Real GDP growth nowcast for the current quarter, annualized percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "forecast", + "type": "float | None", + "description": "Real GDP growth forecast for the next quarter, annualized percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkNowcast", + "openapi_extra": { + "widget_config": { + "name": "NY Fed Staff Nowcast", + "description": "Weekly nowcast of U.S. real GDP growth (annualized percent) - the backcast, nowcast, and forecast by forecast vintage date.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "reference_quarter", + "headerName": "Reference Quarter" + }, + { + "field": "backcast", + "headerName": "Backcast", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "nowcast", + "headerName": "Nowcast", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "forecast", + "headerName": "Forecast", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveNewYorkNowcast" + } + }, + "/federal_reserve/ny/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the New York Fed report PDF archives in a multi-file viewer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.publications(provider='federal_reserve')\n# Filter the catalog to one report series.\nobb.federal_reserve.ny.publications(series='empire_state_report', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Staff Reports", + "value": "staff_reports" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Economic Policy Review", + "value": "economic_policy_review" + }, + { + "label": "Research Paper", + "value": "research_paper" + }, + { + "label": "Current Issues in Economics and Finance", + "value": "current_issues_in_economics_and_finance" + }, + { + "label": "Quarterly Review", + "value": "quarterly_review" + }, + { + "label": "The Regional Economy of Upstate New York", + "value": "the_regional_economy_of_upstate_new_york" + }, + { + "label": "Annual Report Domestic Open Market Operations", + "value": "annual_report_domestic_open_market_operations" + }, + { + "label": "Upstate New York Regional Review", + "value": "upstate_new_york_regional_review" + }, + { + "label": "Upstate New York At-a-Glance", + "value": "upstate_new_york_at_a_glance" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkPublications", + "openapi_extra": { + "model": "FederalReserveNewYorkPublications" + } + }, + "/federal_reserve/ny/sofr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Secured Overnight Financing Rate (SOFR).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.sofr(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSOFR", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Effective federal funds rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "federal_reserve": [] + }, + "model": "FederalReserveSOFR", + "openapi_extra": { + "widget_config": { + "name": "Secured Overnight Financing Rate (SOFR)", + "description": "Daily SOFR benchmark rate and its percentile distribution, in percent, with transaction volume.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "rate", + "headerName": "Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_1", + "headerName": "1st Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_25", + "headerName": "25th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_75", + "headerName": "75th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_99", + "headerName": "99th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveSOFR" + } + }, + "/federal_reserve/ny/effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Effective Federal Funds Rate data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.effr(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveFederalFundsRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Effective federal funds rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "target_range_upper", + "type": "float | None", + "description": "Upper bound of the target range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "target_range_lower", + "type": "float | None", + "description": "Lower bound of the target range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "federal_reserve": [ + { + "name": "intraday_low", + "type": "float | None", + "description": "Intraday low. This field is only present for data before 2016.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "intraday_high", + "type": "float | None", + "description": "Intraday high. This field is only present for data before 2016.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standard_deviation", + "type": "float | None", + "description": "Standard deviation. This field is only present for data before 2016.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revision_indicator", + "type": "str | None", + "description": "Indicates a revision of the data for that date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveFederalFundsRate", + "openapi_extra": { + "widget_config": { + "name": "Effective Federal Funds Rate (EFFR)", + "description": "Daily effective federal funds rate, target range, and percentile distribution, in percent, with transaction volume.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "rate", + "headerName": "Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "target_range_upper", + "headerName": "Target Range Upper", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "target_range_lower", + "headerName": "Target Range Lower", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_1", + "headerName": "1st Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_25", + "headerName": "25th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_75", + "headerName": "75th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_99", + "headerName": "99th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "intraday_low", + "headerName": "Intraday Low", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "intraday_high", + "headerName": "Intraday High", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "standard_deviation", + "headerName": "Standard Deviation", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "revision_indicator", + "headerName": "Revision Indicator" + } + ] + } + } + }, + "model": "FederalReserveFederalFundsRate" + } + }, + "/federal_reserve/ny/overnight_bank_funding": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Overnight Bank Funding Rate (OBFR).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.overnight_bank_funding(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveOvernightBankFundingRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Overnight Bank Funding Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "federal_reserve": [ + { + "name": "revision_indicator", + "type": "str | None", + "description": "Indicates a revision of the data for that date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveOvernightBankFundingRate", + "openapi_extra": { + "widget_config": { + "name": "Overnight Bank Funding Rate (OBFR)", + "description": "Daily OBFR benchmark rate and its percentile distribution, in percent, with transaction volume.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "rate", + "headerName": "Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_1", + "headerName": "1st Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_25", + "headerName": "25th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_75", + "headerName": "75th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percentile_99", + "headerName": "99th Percentile", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "revision_indicator", + "headerName": "Revision Indicator" + } + ] + } + } + }, + "model": "FederalReserveOvernightBankFundingRate" + } + }, + "/federal_reserve/ny/central_bank_holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the System Open Market Account (SOMA) balance sheet holdings.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The default is the latest Treasury securities held by the Federal Reserve.\nobb.federal_reserve.ny.central_bank_holdings(provider='federal_reserve')\n# Get historical summaries of the Fed's holdings.\nobb.federal_reserve.ny.central_bank_holdings(provider='federal_reserve', summary=True)\n# Get the balance sheet holdings as-of a historical date.\nobb.federal_reserve.ny.central_bank_holdings(provider='federal_reserve', date='2019-05-21')\n# Use the `holding_type` parameter to select Agency securities, or specific categories or Treasury securities.\nobb.federal_reserve.ny.central_bank_holdings(provider='federal_reserve', holding_type='agency_debts')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "A specific date to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [ + { + "name": "holding_type", + "type": "str | None", + "description": "Type of holdings to return.", + "default": "all_treasury", + "optional": true, + "choices": [ + "all_agency", + "agency_debts", + "mbs", + "cmbs", + "all_treasury", + "bills", + "notesbonds", + "frn", + "tips" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Agency securities", + "value": "all_agency" + }, + { + "label": "Agency debts", + "value": "agency_debts" + }, + { + "label": "Agency mortgage-backed securities (MBS)", + "value": "mbs" + }, + { + "label": "Agency commercial mortgage-backed securities (CMBS)", + "value": "cmbs" + }, + { + "label": "All Treasury securities", + "value": "all_treasury" + }, + { + "label": "Treasury bills", + "value": "bills" + }, + { + "label": "Treasury notes and bonds", + "value": "notesbonds" + }, + { + "label": "Treasury floating rate notes (FRN)", + "value": "frn" + }, + { + "label": "Treasury inflation-protected securities (TIPS)", + "value": "tips" + } + ] + } + } + }, + { + "name": "summary", + "type": "bool | None", + "description": "If True, returns historical weekly summary by holding type. This parameter takes priority over other parameters.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None | list[str | None]", + "description": " Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "wam", + "type": "bool | None", + "description": "If True, returns weighted average maturity aggregated by agency or treasury securities. This parameter takes priority over `holding_type`, `cusip`, and `monthly`.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "monthly", + "type": "bool | None", + "description": "If True, returns historical data for all Treasury securities at a monthly interval. This parameter takes priority over other parameters, except `wam`. Only valid when `holding_type` is set to: 'all_treasury', 'bills', 'notesbonds', 'frn', 'tips'.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveCentralBankHoldings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [ + { + "name": "security_type", + "type": "str | None", + "description": "Type of security - i.e. TIPs, FRNs, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the security. Only returned for Agency securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_aggregated", + "type": "str | None", + "description": "Whether the security is aggregated. Only returned for Agency securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "Issuer of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Maturity date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "term", + "type": "str | None", + "description": "Term of the security. Only returned for Agency securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "face_value", + "type": "float | None", + "description": "Current face value of the security ($USD). Current face value of the securities, which is the remaining principal balance of the securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "par_value", + "type": "float | None", + "description": "Par value of the security ($USD). Changes in par may reflect primary and secondary market transactions and/or custodial account activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon", + "type": "float | None", + "description": "Coupon rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "spread", + "type": "float | None", + "description": "Spread to the current reference rate, as determined at each security's initial auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percent_outstanding", + "type": "float | None", + "description": "Total percent of the outstanding CUSIP issuance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "bills", + "type": "float | None", + "description": "Treasury bills amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frn", + "type": "float | None", + "description": "Floating rate Treasury notes amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "notes_and_bonds", + "type": "float | None", + "description": "Treasuy Notes and bonds amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tips", + "type": "float | None", + "description": "Treasury inflation-protected securities amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mbs", + "type": "float | None", + "description": "Mortgage-backed securities amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cmbs", + "type": "float | None", + "description": "Commercial mortgage-backed securities amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "agencies", + "type": "float | None", + "description": "Agency securities amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total", + "type": "float | None", + "description": "Total SOMA holdings amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tips_inflation_compensation", + "type": "float | None", + "description": "Treasury inflation-protected securities inflation compensation amount ($USD). Only returned when 'summary' is True.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_prior_week", + "type": "float | None", + "description": "Change in SOMA holdings from the prior week ($USD).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_prior_year", + "type": "float | None", + "description": "Change in SOMA holdings from the prior year ($USD).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveCentralBankHoldings", + "openapi_extra": { + "widget_config": { + "name": "System Open Market Account (SOMA) Holdings", + "description": "Treasury and Agency securities held by the Federal Reserve and managed by the New York Fed, in USD.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "security_type", + "headerName": "Security Type" + }, + { + "field": "cusip", + "headerName": "CUSIP" + }, + { + "field": "description", + "headerName": "Description" + }, + { + "field": "term", + "headerName": "Term" + }, + { + "field": "issuer", + "headerName": "Issuer" + }, + { + "field": "maturity_date", + "headerName": "Maturity Date", + "cellDataType": "date" + }, + { + "field": "par_value", + "headerName": "Par Value", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "face_value", + "headerName": "Face Value", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupon", + "headerName": "Coupon", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "spread", + "headerName": "Spread", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "percent_outstanding", + "headerName": "Percent Outstanding", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "change_prior_week", + "headerName": "Change Prior Week", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "change_prior_year", + "headerName": "Change Prior Year", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "bills", + "headerName": "Bills", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "notes_and_bonds", + "headerName": "Notes & Bonds", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "frn", + "headerName": "FRN", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "tips", + "headerName": "TIPS", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "tips_inflation_compensation", + "headerName": "TIPS Inflation Compensation", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "mbs", + "headerName": "MBS", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "cmbs", + "headerName": "CMBS", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "agencies", + "headerName": "Agencies", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "total", + "headerName": "Total", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReserveCentralBankHoldings" + } + }, + "/federal_reserve/ny/primary_dealer_positioning": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Primary dealer positioning statistics.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.primary_dealer_positioning(provider='federal_reserve')\nobb.federal_reserve.ny.primary_dealer_positioning(category='abs', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [ + { + "name": "category", + "type": "str | None", + "description": "The category of asset to return, defaults to 'treasuries'.", + "default": "treasuries", + "optional": true, + "choices": [ + "treasuries", + "bills", + "coupons", + "notes", + "tips", + "mbs", + "cmbs", + "municipal", + "corporate", + "commercial_paper", + "corporate_ig", + "corporate_junk", + "abs" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "U.S. Treasury securities", + "value": "treasuries" + }, + { + "label": "Treasury bills", + "value": "bills" + }, + { + "label": "Treasury coupons", + "value": "coupons" + }, + { + "label": "Treasury notes and bonds", + "value": "notes" + }, + { + "label": "Treasury inflation-protected securities (TIPS)", + "value": "tips" + }, + { + "label": "Mortgage-backed securities (MBS)", + "value": "mbs" + }, + { + "label": "Commercial mortgage-backed securities (CMBS)", + "value": "cmbs" + }, + { + "label": "Municipal securities", + "value": "municipal" + }, + { + "label": "Corporate securities", + "value": "corporate" + }, + { + "label": "Commercial paper", + "value": "commercial_paper" + }, + { + "label": "Investment-grade corporate bonds", + "value": "corporate_ig" + }, + { + "label": "Below-investment-grade corporate bonds", + "value": "corporate_junk" + }, + { + "label": "Asset-backed securities (ABS)", + "value": "abs" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePrimaryDealerPositioning", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePrimaryDealerPositioning", + "openapi_extra": { + "widget_config": { + "name": "Primary Dealer Positioning", + "description": "Weekly net positions (long minus short) reported by primary dealers, by series, in millions of USD.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "bills", + "headerName": "Bills (Ex-TIPS)", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_lte_2_years", + "headerName": "Coupons <=2Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_gt_2_years_lt_3_years", + "headerName": "Coupons 2-3Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_gt_3_years_lt_6_years", + "headerName": "Coupons 3-6Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_gt_6_years_lt_7_years", + "headerName": "Coupons 6-7Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_gt_7_years_lt_11_years", + "headerName": "Coupons 7-11Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_gt_11_years_lt_21_years", + "headerName": "Coupons 11-21Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_gt_21_years", + "headerName": "Coupons 21Y+", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "tips_lt_2_years", + "headerName": "TIPS <=2Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "tips_gt_2_years_lt_6_years", + "headerName": "TIPS 2-6Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "tips_gt_6_years_lt_11_years", + "headerName": "TIPS 6-11Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "tips_gt_11_years", + "headerName": "TIPS 11Y+", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "floating_rate_notes", + "headerName": "Floating Rate Notes", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "discount_notes", + "headerName": "Agency & GSE Discount Notes", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "coupons_agency", + "headerName": "Agency & GSE Coupons", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "mbs_agency_and_gse_tba", + "headerName": "MBS Agency & GSE TBAs", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "mbs_agency_and_gse_other_residential", + "headerName": "MBS Agency & GSE Other Residential", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "mbs_agency_and_gse_specified_pools", + "headerName": "MBS Agency & GSE Specified Pools", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "mbs_non_agency_residential", + "headerName": "MBS Non-Agency Residential", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "cmbs_agency_and_gse", + "headerName": "CMBS Agency & GSE", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "cmbs_non_agency", + "headerName": "CMBS Non-Agency", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "municipal_lt_13_months", + "headerName": "Municipal <=13M", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "municipal_gt_13_months_lt_5_years", + "headerName": "Municipal 13M-5Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "municipal_gt_5_years_lt_10_years", + "headerName": "Municipal 5-10Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "municipal_gt_10_years", + "headerName": "Municipal 10Y+", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "commercial_paper", + "headerName": "Commercial Paper", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_investment_grade_lt_13_months", + "headerName": "Corporate IG <=13M", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_investment_grade_gt_13_months_lt_5_years", + "headerName": "Corporate IG 13M-5Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_investment_grade_gt_5_years_lt_10_years", + "headerName": "Corporate IG 5-10Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_investment_grade_gt_10_years", + "headerName": "Corporate IG 10Y+", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_junk_lt_13_months", + "headerName": "Corporate HY <=13M", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_junk_gt_13_months_lt_5_years", + "headerName": "Corporate HY 13M-5Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_junk_gt_5_years_lt_10_years", + "headerName": "Corporate HY 5-10Y", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "corporate_junk_gt_10_years", + "headerName": "Corporate HY 10Y+", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "abs_autos", + "headerName": "ABS Autos", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "abs_credit_cards", + "headerName": "ABS Credit Cards", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "abs_student_loans", + "headerName": "ABS Student Loans", + "cellDataType": "number", + "formatterFn": "int" + }, + { + "field": "abs_other", + "headerName": "ABS Other", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReservePrimaryDealerPositioning" + } + }, + "/federal_reserve/ny/primary_dealer_fails": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Primary Dealer Statistics for Fails to Deliver and Fails to Receive.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.primary_dealer_fails(provider='federal_reserve')\n# Transform the data to be percentage totals by asset class.\nobb.federal_reserve.ny.primary_dealer_fails(provider='federal_reserve', unit='percent')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "federal_reserve": [ + { + "name": "asset_class", + "type": "str | None", + "description": "Asset class to return, default is 'all'.", + "default": "all", + "optional": true, + "choices": [ + "all", + "treasuries", + "tips", + "agency", + "mbs", + "corporate" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All asset classes", + "value": "all" + }, + { + "label": "U.S. Treasury securities (ex-TIPS)", + "value": "treasuries" + }, + { + "label": "Treasury inflation-protected securities (TIPS)", + "value": "tips" + }, + { + "label": "Federal agency securities (ex-MBS)", + "value": "agency" + }, + { + "label": "Mortgage-backed securities (MBS)", + "value": "mbs" + }, + { + "label": "Corporate securities", + "value": "corporate" + } + ] + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the data returned to the 'value' field. Default is 'value', which represents millions of USD. 'percent' returns data as the percentage of the total fails-to-receive and fails-to-deliver, by asset class.", + "default": "value", + "optional": true, + "choices": [ + "value", + "percent" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Value (millions of USD)", + "value": "value" + }, + { + "label": "Percent of total fails", + "value": "percent" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePrimaryDealerFails", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePrimaryDealerFails", + "openapi_extra": { + "widget_config": { + "name": "Primary Dealer Fails to Deliver and Receive", + "description": "Weekly settlement fails reported by primary dealers, by series, in millions of USD or as a share of total fails.", + "subCategory": "Rates & Markets", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "chartDataType": "time", + "pinned": "left", + "sort": "desc" + }, + { + "field": "FTD Treasury Securities (Ex-TIPS)", + "headerName": "FTD Treasury Securities (Ex-TIPS)", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTD TIPS", + "headerName": "FTD TIPS", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTD Agency and GSE Securities (Ex-MBS)", + "headerName": "FTD Agency and GSE Securities (Ex-MBS)", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTD Agency and GSE MBS", + "headerName": "FTD Agency and GSE MBS", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTD Other MBS", + "headerName": "FTD Other MBS", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTD Corporate Securities", + "headerName": "FTD Corporate Securities", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTD Total", + "headerName": "FTD Total", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR Treasury Securities (Ex-TIPS)", + "headerName": "FTR Treasury Securities (Ex-TIPS)", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR TIPS", + "headerName": "FTR TIPS", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR Agency and GSE Securities (Ex-MBS)", + "headerName": "FTR Agency and GSE Securities (Ex-MBS)", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR Agency and GSE MBS", + "headerName": "FTR Agency and GSE MBS", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR Other MBS", + "headerName": "FTR Other MBS", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR Corporate Securities", + "headerName": "FTR Corporate Securities", + "cellDataType": "number", + "chartDataType": "series" + }, + { + "field": "FTR Total", + "headerName": "FTR Total", + "cellDataType": "number", + "chartDataType": "series" + } + ] + } + } + }, + "model": "FederalReservePrimaryDealerFails" + } + }, + "/federal_reserve/ny/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported New York Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.ny.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveNewYorkPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveNewYorkPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "New York Fed Publication Series", + "description": "The publication series supported by the New York Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveNewYorkPublicationSeries" + } + }, + "/federal_reserve/philadelphia/business_conditions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed ADS Business Conditions Index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.business_conditions(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaAds", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "ads_index", + "type": "float | None", + "description": "The ADS Business Conditions Index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recession", + "type": "float | None", + "description": "The NBER recession indicator for the date, 1 in recession.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaAds", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed ADS Business Conditions Index", + "subCategory": "Business Conditions", + "description": "Daily Aruoba-Diebold-Scotti index of real U.S. business conditions, with the NBER recession indicator.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "ads_index", + "headerName": "ADS Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "recession", + "headerName": "Recession", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaAds" + } + }, + "/federal_reserve/philadelphia/survey_professional_forecasters": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed Survey of Professional Forecasters consensus.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.survey_professional_forecasters(provider='federal_reserve')\n# Get the mean nominal GDP growth forecast.\nobb.federal_reserve.philadelphia.survey_professional_forecasters(variable='NGDP', statistic='mean', transform='growth', provider='federal_reserve')\n# Get the long-run CPI inflation projection.\nobb.federal_reserve.philadelphia.survey_professional_forecasters(variable='CPI10', statistic='median', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "variable", + "type": "str | None", + "description": "The forecast variable code, e.g. 'RGDP' for real GDP. Codes ending in '10' (e.g. 'CPI10', 'RGDP10') are long-run, ten-year-average projections published only as a level.", + "default": "RGDP", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Nominal GDP", + "value": "NGDP" + }, + { + "label": "GDP Price Index", + "value": "PGDP" + }, + { + "label": "Real GDP", + "value": "RGDP" + }, + { + "label": "Real Consumption", + "value": "RCONSUM" + }, + { + "label": "Real Nonresidential Fixed Investment", + "value": "RNRESIN" + }, + { + "label": "Real Residential Fixed Investment", + "value": "RRESINV" + }, + { + "label": "Real Federal Government Spending", + "value": "RFEDGOV" + }, + { + "label": "Real State & Local Government Spending", + "value": "RSLGOV" + }, + { + "label": "Real Net Exports", + "value": "REXPORT" + }, + { + "label": "Real Change in Private Inventories", + "value": "RCBI" + }, + { + "label": "Housing Starts", + "value": "HOUSING" + }, + { + "label": "Industrial Production", + "value": "INDPROD" + }, + { + "label": "Nonfarm Payroll Employment", + "value": "EMP" + }, + { + "label": "Unemployment Rate", + "value": "UNEMP" + }, + { + "label": "CPI Inflation", + "value": "CPI" + }, + { + "label": "Core CPI Inflation", + "value": "CORECPI" + }, + { + "label": "PCE Inflation", + "value": "PCE" + }, + { + "label": "Core PCE Inflation", + "value": "COREPCE" + }, + { + "label": "3-Month Treasury Bill Rate", + "value": "TBILL" + }, + { + "label": "10-Year Treasury Bond Rate", + "value": "TBOND" + }, + { + "label": "Aaa Corporate Bond Rate", + "value": "BOND" + }, + { + "label": "Baa Corporate Bond Rate", + "value": "BAABOND" + }, + { + "label": "Corporate Profits After Tax", + "value": "CPROF" + }, + { + "label": "Anxious Index (Recession Probability)", + "value": "RECESS" + }, + { + "label": "10-Year CPI Inflation", + "value": "CPI10" + }, + { + "label": "10-Year PCE Inflation", + "value": "PCE10" + }, + { + "label": "10-Year Real GDP Growth", + "value": "RGDP10" + }, + { + "label": "10-Year Productivity Growth", + "value": "PROD10" + }, + { + "label": "10-Year Treasury Bond Rate (Long-Run)", + "value": "BOND10" + } + ] + } + } + }, + { + "name": "statistic", + "type": "str | None", + "description": "The cross-forecaster summary statistic.", + "default": "median", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Mean", + "value": "mean" + }, + { + "label": "Median", + "value": "median" + } + ] + } + } + }, + { + "name": "transform", + "type": "str | None", + "description": "The series transform; 'growth' is only published for level-and-growth variables.", + "default": "level", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Level", + "value": "level" + }, + { + "label": "Growth", + "value": "growth" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaSpf", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter, as a quarter-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "horizon_1", + "type": "float | None", + "description": "The current-quarter forecast.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon_2", + "type": "float | None", + "description": "The one-quarter-ahead forecast.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon_3", + "type": "float | None", + "description": "The two-quarter-ahead forecast.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon_4", + "type": "float | None", + "description": "The three-quarter-ahead forecast.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon_5", + "type": "float | None", + "description": "The four-quarter-ahead forecast.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon_6", + "type": "float | None", + "description": "The five-quarter-ahead forecast.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annual_a", + "type": "float | None", + "description": "The forecast for the current year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annual_b", + "type": "float | None", + "description": "The forecast for the next year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annual_c", + "type": "float | None", + "description": "The forecast for two years ahead.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annual_d", + "type": "float | None", + "description": "The forecast for three years ahead.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_run", + "type": "float | None", + "description": "The ten-year-average projection, for long-run variables.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaSpf", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Survey of Professional Forecasters", + "subCategory": "Forecasts & Expectations", + "description": "Quarterly consensus mean or median forecasts by horizon for the selected macroeconomic variable.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "horizon_1", + "headerName": "Current Quarter", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "horizon_2", + "headerName": "1Q Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "horizon_3", + "headerName": "2Q Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "horizon_4", + "headerName": "3Q Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "horizon_5", + "headerName": "4Q Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "horizon_6", + "headerName": "5Q Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "annual_a", + "headerName": "Current Year", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "annual_b", + "headerName": "Next Year", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "annual_c", + "headerName": "2 Years Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "annual_d", + "headerName": "3 Years Ahead", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "long_run", + "headerName": "Long Run", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaSpf" + } + }, + "/federal_reserve/philadelphia/anxious_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed Anxious Index recession probability series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.anxious_index(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaAnxious", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter, as a quarter-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "anxious_index", + "type": "float | None", + "description": "The probability of a decline in real GDP next quarter, percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recession", + "type": "float | None", + "description": "The NBER recession indicator for the quarter, when present.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaAnxious", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Anxious Index", + "subCategory": "Forecasts & Expectations", + "description": "Survey-based probability of a decline in real GDP next quarter, with the NBER recession indicator.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "anxious_index", + "headerName": "Anxious Index", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "recession", + "headerName": "Recession", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaAnxious" + } + }, + "/federal_reserve/philadelphia/gdpplus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed GDPplus measure of output growth.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.gdpplus(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaGdpPlus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The quarter, as a quarter-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "gdpplus", + "type": "float | None", + "description": "The GDPplus annualized growth rate, percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gdp_growth", + "type": "float | None", + "description": "The expenditure-side GDP growth rate, percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gdi_growth", + "type": "float | None", + "description": "The income-side GDI growth rate, percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recession", + "type": "float | None", + "description": "The NBER recession indicator for the quarter, 1 in recession.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaGdpPlus", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed GDPplus", + "subCategory": "Output & Risk", + "description": "Annualized quarterly GDPplus output growth with the underlying GDP and GDI growth rates and the NBER recession indicator.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "gdpplus", + "headerName": "GDPplus", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "gdp_growth", + "headerName": "GDP Growth", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "gdi_growth", + "headerName": "GDI Growth", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "recession", + "headerName": "Recession", + "cellDataType": "number", + "formatterFn": "int" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaGdpPlus" + } + }, + "/federal_reserve/philadelphia/partisan_conflict": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed Partisan Conflict Index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.partisan_conflict(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaPartisan", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The month, as a month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "partisan_conflict", + "type": "float | None", + "description": "The Partisan Conflict Index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaPartisan", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Partisan Conflict Index", + "subCategory": "Output & Risk", + "description": "Monthly index of the degree of political disagreement among U.S. federal politicians.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "partisan_conflict", + "headerName": "Partisan Conflict", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaPartisan" + } + }, + "/federal_reserve/philadelphia/state_coincident_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed State Coincident Indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.state_coincident_index(provider='federal_reserve')\n# Get a single state's coincident index.\nobb.federal_reserve.philadelphia.state_coincident_index(state='PA', provider='federal_reserve')\n# Get the diffusion of state-index increases.\nobb.federal_reserve.philadelphia.state_coincident_index(dataset='diffusion', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "dataset", + "type": "str | None", + "description": "The per-state coincident indexes, or the one- and three-month diffusion of state index increases.", + "default": "indexes", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Indexes", + "value": "indexes" + }, + { + "label": "Diffusion", + "value": "diffusion" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Filter to a single series; for 'indexes' a two-letter state code (e.g. 'PA') or 'US', for 'diffusion' a code ('DI1' or 'DI3').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaCoincident", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The month, as a month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str", + "description": "The two-letter state code or 'US', or the diffusion-series code ('DI1' or 'DI3').", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaCoincident", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed State Coincident Indexes", + "subCategory": "Business Conditions", + "description": "Monthly state-level coincident indexes of current economic conditions, or the diffusion of state-index increases.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "state", + "headerName": "State" + }, + { + "field": "value", + "headerName": "Value", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaCoincident" + } + }, + "/federal_reserve/philadelphia/livingston_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed Livingston Survey forecasts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.livingston_survey(provider='federal_reserve')\n# Get the median CPI forecast.\nobb.federal_reserve.philadelphia.livingston_survey(variable='CPI', statistic='median', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "variable", + "type": "str | None", + "description": "The forecast variable sheet code, e.g. 'RGDPX' for real GDP.", + "default": "RGDPX", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Real GDP", + "value": "RGDPX" + }, + { + "label": "Nominal GDP", + "value": "GDPX" + }, + { + "label": "Nonresidential Fixed Investment", + "value": "BFIX" + }, + { + "label": "Corporate Profits After Tax", + "value": "CPAT" + }, + { + "label": "Industrial Production", + "value": "IP" + }, + { + "label": "Housing Starts", + "value": "TPHS" + }, + { + "label": "Producer Price Index", + "value": "PPI" + }, + { + "label": "Consumer Price Index", + "value": "CPI" + }, + { + "label": "Unemployment Rate", + "value": "UNPR" + }, + { + "label": "Average Weekly Earnings, Manufacturing", + "value": "WMFG" + }, + { + "label": "Retail Trade", + "value": "RTTR" + }, + { + "label": "Auto Sales", + "value": "AUTODF" + }, + { + "label": "Prime Rate", + "value": "PRIME" + }, + { + "label": "10-Year Treasury Bond Rate", + "value": "TBOND" + }, + { + "label": "3-Month Treasury Bill Rate", + "value": "TBILL" + }, + { + "label": "S&P 500 Stock Price Index", + "value": "SPIF" + } + ] + } + } + }, + { + "name": "statistic", + "type": "str | None", + "description": "The cross-forecaster summary statistic.", + "default": "mean", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Mean", + "value": "mean" + }, + { + "label": "Median", + "value": "median" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaLivingston", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey date, June or December.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "base_prior", + "type": "float | None", + "description": "The prior-period base value ('BP').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "base_current", + "type": "float | None", + "description": "The current-period base value ('ZM').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "six_month", + "type": "float | None", + "description": "The six-month-ahead forecast ('6M').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "twelve_month", + "type": "float | None", + "description": "The twelve-month-ahead forecast ('12M').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "base_year", + "type": "float | None", + "description": "The base-year annual value ('BY').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_year", + "type": "float | None", + "description": "The current-year annual value ('ZY').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "one_year", + "type": "float | None", + "description": "The one-year-ahead annual forecast ('1Y').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "two_year", + "type": "float | None", + "description": "The two-year-ahead annual forecast ('2Y').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ten_year", + "type": "float | None", + "description": "The ten-year-ahead annual forecast ('10Y').", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaLivingston", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Livingston Survey", + "subCategory": "Forecasts & Expectations", + "description": "Semiannual consensus economist forecasts by horizon for the selected variable.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "base_prior", + "headerName": "Base Prior", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "base_current", + "headerName": "Base Current", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "six_month", + "headerName": "Six Month", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "twelve_month", + "headerName": "Twelve Month", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "base_year", + "headerName": "Base Year", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "current_year", + "headerName": "Current Year", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "one_year", + "headerName": "One Year", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "two_year", + "headerName": "Two Year", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "ten_year", + "headerName": "Ten Year", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaLivingston" + } + }, + "/federal_reserve/philadelphia/manufacturing_outlook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed Manufacturing Business Outlook Survey indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.manufacturing_outlook(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaManufacturing", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month, as a month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaManufacturing", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Manufacturing Business Outlook Survey", + "subCategory": "Outlook Surveys", + "description": "Monthly manufacturing diffusion indexes, one column per indicator code, for the Third Federal Reserve District.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaManufacturing" + } + }, + "/federal_reserve/philadelphia/nonmanufacturing_outlook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed Nonmanufacturing Business Outlook Survey indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.nonmanufacturing_outlook(provider='federal_reserve')\n# Get the not-seasonally-adjusted response shares.\nobb.federal_reserve.philadelphia.nonmanufacturing_outlook(adjustment='nsa', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "adjustment", + "type": "str | None", + "description": "The seasonally-adjusted or not-seasonally-adjusted series; each carries both the diffusion indexes and the increase/no-change/decrease response shares.", + "default": "sa", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Seasonally Adjusted", + "value": "sa" + }, + { + "label": "Not Seasonally Adjusted", + "value": "nsa" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaNonmanufacturing", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month, as a month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaNonmanufacturing", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Nonmanufacturing Business Outlook Survey", + "subCategory": "Outlook Surveys", + "description": "Monthly service-sector diffusion indexes and response shares by indicator, adjustment, horizon, and response component.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaNonmanufacturing" + } + }, + "/federal_reserve/philadelphia/term_structure_inflation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Philadelphia Fed ATSIX term structure of inflation expectations.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.term_structure_inflation(provider='federal_reserve')\n# Get the fitted Nelson-Siegel factors.\nobb.federal_reserve.philadelphia.term_structure_inflation(dataset='factors', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "dataset", + "type": "str | None", + "description": "The expected-inflation term structure, the ex-ante real-rate term structure, or the fitted Nelson-Siegel factors. Every forecast horizon, or every Nelson-Siegel factor, is returned as its own column.", + "default": "inflation", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Inflation", + "value": "inflation" + }, + { + "label": "Real", + "value": "real" + }, + { + "label": "Factors", + "value": "factors" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaAtsix", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The vintage month, as a month-start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaAtsix", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed ATSIX Inflation Expectations", + "subCategory": "Forecasts & Expectations", + "description": "Monthly Aruoba term structure of expected CPI inflation by horizon, the ex-ante real-rate term structure, or the Nelson-Siegel factors, one column per horizon or factor.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaAtsix" + } + }, + "/federal_reserve/philadelphia/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Philadelphia Fed survey-report PDF archive.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.publications(provider='federal_reserve')\n# Index only the Survey of Professional Forecasters reports.\nobb.federal_reserve.philadelphia.publications(series='spf', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Working Papers", + "value": "working_papers" + }, + { + "label": "Business Review", + "value": "business_review" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Consumer Finance Institute discussion papers", + "value": "consumer_finance_institute_discussion_papers" + }, + { + "label": "Economic Insights", + "value": "economic_insights" + }, + { + "label": "Consumer Finance Institute Research Briefs and Special Reports", + "value": "consumer_finance_institute_research_briefs_and_special_reports" + }, + { + "label": "Research Rap Special Report", + "value": "research_rap_special_report" + }, + { + "label": "Community Affairs Discussion Paper", + "value": "community_affairs_discussion_paper" + }, + { + "label": "Banking Trends", + "value": "banking_trends" + }, + { + "label": "Regional Spotlight", + "value": "regional_spotlight" + }, + { + "label": "Cascade Focus", + "value": "cascade_focus" + }, + { + "label": "Research Brief", + "value": "research_brief" + }, + { + "label": "Consumer Finance Institute conference summaries", + "value": "consumer_finance_institute_conference_summaries" + }, + { + "label": "Monograph", + "value": "monograph" + }, + { + "label": "Beyond the Numbers", + "value": "beyond_the_numbers" + }, + { + "label": "Banking Policy Review", + "value": "banking_policy_review" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaPublications", + "openapi_extra": { + "model": "FederalReservePhiladelphiaPublications" + } + }, + "/federal_reserve/philadelphia/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Philadelphia Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.philadelphia.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReservePhiladelphiaPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReservePhiladelphiaPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Philadelphia Fed Publication Series", + "description": "The publication series supported by the Philadelphia Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReservePhiladelphiaPublicationSeries" + } + }, + "/federal_reserve/richmond/manufacturing_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Richmond Fed Fifth District Survey of Manufacturing Activity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.manufacturing_survey(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondManufacturing", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The seasonal adjustment (NSA or SA).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon", + "type": "str | None", + "description": "Current conditions or six-month-ahead expectations.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondManufacturing", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed Manufacturing Survey", + "subCategory": "Business Surveys", + "description": "Fifth District Survey of Manufacturing Activity diffusion indexes, by indicator and horizon.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "adjustment", + "headerName": "Adjustment" + }, + { + "field": "horizon", + "headerName": "Horizon" + } + ] + } + } + }, + "model": "FederalReserveRichmondManufacturing" + } + }, + "/federal_reserve/richmond/service_sector_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Richmond Fed Fifth District Survey of Service Sector Activity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.service_sector_survey(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondServiceSector", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The seasonal adjustment (NSA or SA).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon", + "type": "str | None", + "description": "Current conditions or six-month-ahead expectations.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondServiceSector", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed Service Sector Survey", + "subCategory": "Business Surveys", + "description": "Fifth District Survey of Service Sector Activity diffusion indexes, by indicator and horizon.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "adjustment", + "headerName": "Adjustment" + }, + { + "field": "horizon", + "headerName": "Horizon" + } + ] + } + } + }, + "model": "FederalReserveRichmondServiceSector" + } + }, + "/federal_reserve/richmond/state_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a Richmond Fed Fifth District state business survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.state_survey(provider='federal_reserve')\n# Get the Carolinas survey.\nobb.federal_reserve.richmond.state_survey(state='carolinas', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "state", + "type": "str | None", + "description": "The Fifth District jurisdiction survey to retrieve.", + "default": "virginia", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Carolinas", + "value": "carolinas" + }, + { + "label": "Maryland", + "value": "maryland" + }, + { + "label": "Virginia", + "value": "virginia" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondStateSurvey", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The seasonal adjustment (NSA or SA).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "horizon", + "type": "str | None", + "description": "Current conditions or six-month-ahead expectations.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondStateSurvey", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed State Business Survey", + "subCategory": "Business Surveys", + "description": "Fifth District per-state combined business survey diffusion indexes, by indicator and horizon.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "adjustment", + "headerName": "Adjustment" + }, + { + "field": "horizon", + "headerName": "Horizon" + } + ] + } + } + }, + "model": "FederalReserveRichmondStateSurvey" + } + }, + "/federal_reserve/richmond/cfo_survey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Richmond Fed CFO Survey optimism series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.cfo_survey(provider='federal_reserve')\n# Get the legacy pre-Q2-2020 Duke CFO Survey series.\nobb.federal_reserve.richmond.cfo_survey(table='legacy_through_q1_2020', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The CFO Survey table to return: optimism, expectations, spending, GDP/S&P 500 forecasts, investment plans, or credit conditions - several broken out by firm size, employment, or sector. The 'legacy_through_q1_2020' table holds the pre-Q2-2020 Duke CFO Survey series (optimism, growth expectations, and S&P 500 forecasts).", + "default": "optimism", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Optimism", + "value": "optimism" + }, + { + "label": "Optimism by Size", + "value": "optimism_by_size" + }, + { + "label": "Optimism by Employment", + "value": "optimism_by_employment" + }, + { + "label": "Optimism by Sector", + "value": "optimism_by_sector" + }, + { + "label": "Expectations", + "value": "expectations" + }, + { + "label": "Expectations by Employment", + "value": "expectations_by_employment" + }, + { + "label": "Expectations by Sector", + "value": "expectations_by_sector" + }, + { + "label": "Spending 3mo", + "value": "spending_3mo" + }, + { + "label": "Gdp Mean Probability", + "value": "gdp_mean_probability" + }, + { + "label": "Sp500", + "value": "sp500" + }, + { + "label": "Investment Plans", + "value": "investment_plans" + }, + { + "label": "Reason Invest", + "value": "reason_invest" + }, + { + "label": "Reason Not Invest", + "value": "reason_not_invest" + }, + { + "label": "New Credit", + "value": "new_credit" + }, + { + "label": "Credit Received", + "value": "credit_received" + }, + { + "label": "Lenders", + "value": "lenders" + }, + { + "label": "Credit Difficulty", + "value": "credit_difficulty" + }, + { + "label": "Reason Difficult", + "value": "reason_difficult" + }, + { + "label": "Reason Easy", + "value": "reason_easy" + }, + { + "label": "Legacy Through Q1 2020", + "value": "legacy_through_q1_2020" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondCFO", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The survey quarter start date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "The breakdown the row applies to, where the table is disaggregated (e.g. firm size, sector, employment category, or the expectation measure); null for undisaggregated tables.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondCFO", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed CFO Survey", + "subCategory": "Business Surveys", + "description": "Quarterly CFO Survey optimism, expectations, and credit series, by measure and breakdown.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "category", + "headerName": "Category" + } + ] + } + } + }, + "model": "FederalReserveRichmondCFO" + } + }, + "/federal_reserve/richmond/non_employment_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Richmond Fed Non-Employment Index (NEI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.non_employment_index(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondNonEmployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "nei", + "type": "float | None", + "description": "The Non-Employment Index, seasonally adjusted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nei_plus", + "type": "float | None", + "description": "The NEI including those marginally attached / part-time for economic reasons (NEI+PTER).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "u5", + "type": "float | None", + "description": "The official U-5 rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "u6", + "type": "float | None", + "description": "The official U-6 rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unemployment_rate", + "type": "float | None", + "description": "The official U-3 unemployment rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondNonEmployment", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed Non-Employment Index (NEI)", + "subCategory": "Labor & Recession", + "description": "Monthly NEI and NEI+PTER labor-market underutilization, with the official U-5, U-6, and U-3 rates.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "nei", + "headerName": "NEI", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "nei_plus", + "headerName": "NEI+PTER", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "u_5", + "headerName": "U-5", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "u_6", + "headerName": "U-6", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "unemployment_rate", + "headerName": "U-3 Unemployment Rate", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveRichmondNonEmployment" + } + }, + "/federal_reserve/richmond/recession_indicator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Richmond Fed SOS (Sum of Stalls) Recession Indicator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.recession_indicator(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondRecessionIndicator", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The end-of-week observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sos", + "type": "float | None", + "description": "The Sum of Stalls recession indicator value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recession_threshold", + "type": "float | None", + "description": "The constant recession-signal threshold (0.2).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondRecessionIndicator", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed SOS Recession Indicator", + "subCategory": "Labor & Recession", + "description": "Weekly Sum of Stalls (SOS) recession indicator, with its constant 0.2 recession-signal threshold.", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "sos", + "headerName": "Sum of Stalls", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "recession_threshold", + "headerName": "Recession Threshold", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveRichmondRecessionIndicator" + } + }, + "/federal_reserve/richmond/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the Richmond Fed publications catalog on Fed in Print.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.publications(provider='federal_reserve')\n# Index only the Econ Focus series.\nobb.federal_reserve.richmond.publications(series='econ_focus', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Econ Focus", + "value": "econ_focus" + }, + { + "label": "Working Paper", + "value": "working_paper" + }, + { + "label": "Economic Quarterly", + "value": "economic_quarterly" + }, + { + "label": "Economic Review", + "value": "economic_review" + }, + { + "label": "Monograph", + "value": "monograph" + }, + { + "label": "Annual Report", + "value": "annual_report" + }, + { + "label": "Research Digest", + "value": "research_digest" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondPublications", + "openapi_extra": { + "model": "FederalReserveRichmondPublications" + } + }, + "/federal_reserve/richmond/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported Richmond Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.richmond.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveRichmondPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveRichmondPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "Richmond Fed Publication Series", + "description": "The publication series supported by the Richmond Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveRichmondPublicationSeries" + } + }, + "/federal_reserve/sf/news_sentiment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed Daily News Sentiment Index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.news_sentiment(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoNewsSentiment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "news_sentiment", + "type": "float | None", + "description": "The Daily News Sentiment Index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoNewsSentiment", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Daily News Sentiment Index", + "description": "Daily, high-frequency measure of economic sentiment built from the tone of economics coverage in major U.S. newspapers.", + "subCategory": "Activity & Productivity", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "news_sentiment", + "headerName": "News Sentiment", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoNewsSentiment" + } + }, + "/federal_reserve/sf/proxy_funds_rate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed Proxy Funds Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.proxy_funds_rate(provider='federal_reserve')\n# Get the weekly series.\nobb.federal_reserve.sf.proxy_funds_rate(frequency='weekly', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The observation frequency.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Weekly", + "value": "weekly" + }, + { + "label": "Monthly", + "value": "monthly" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoProxyFundsRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "effective_funds_rate", + "type": "float | None", + "description": "The effective federal funds rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "proxy_funds_rate", + "type": "float | None", + "description": "The proxy funds rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoProxyFundsRate", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Proxy Funds Rate", + "description": "Single funds-rate-equivalent gauge of the overall stance of monetary policy, reported alongside the effective federal funds rate.", + "subCategory": "Rates & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "effective_funds_rate", + "headerName": "Effective Funds Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "proxy_funds_rate", + "headerName": "Proxy Funds Rate", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoProxyFundsRate" + } + }, + "/federal_reserve/sf/cyclical_pce": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed Cyclical & Acyclical Core PCE Inflation series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.cyclical_pce(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoCyclicalPce", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cyclical_inflation_yoy", + "type": "float | None", + "description": "Cyclical core PCE inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_inflation_yoy", + "type": "float | None", + "description": "Acyclical core PCE inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cyclical_contribution_yoy", + "type": "float | None", + "description": "Cyclical contribution to core PCE inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_contribution_yoy", + "type": "float | None", + "description": "Acyclical contribution to core PCE inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_healthcare_contribution_yoy", + "type": "float | None", + "description": "Health-care services portion of the acyclical contribution, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_non_healthcare_contribution_yoy", + "type": "float | None", + "description": "Non-health-care portion of the acyclical contribution, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cyclical_inflation_mom", + "type": "float | None", + "description": "Cyclical core PCE inflation, month-over-month annualized.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_inflation_mom", + "type": "float | None", + "description": "Acyclical core PCE inflation, month-over-month annualized.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cyclical_contribution_mom", + "type": "float | None", + "description": "Cyclical contribution to core PCE inflation, month-over-month annualized.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_contribution_mom", + "type": "float | None", + "description": "Acyclical contribution to core PCE inflation, month-over-month annualized.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_healthcare_contribution_mom", + "type": "float | None", + "description": "Health-care services portion of the acyclical contribution, month-over-month annualized.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acyclical_non_healthcare_contribution_mom", + "type": "float | None", + "description": "Non-health-care portion of the acyclical contribution, month-over-month annualized.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoCyclicalPce", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Cyclical & Acyclical Core PCE Inflation", + "description": "Monthly decomposition of core PCE inflation into cyclical and acyclical components, as inflation rates and contributions.", + "subCategory": "Inflation", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "cyclical_inflation_yoy", + "headerName": "Cyclical Inflation (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_inflation_yoy", + "headerName": "Acyclical Inflation (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "cyclical_contribution_yoy", + "headerName": "Cyclical Contribution (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_contribution_yoy", + "headerName": "Acyclical Contribution (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_healthcare_contribution_yoy", + "headerName": "Acyclical Health-Care Contribution (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_non_healthcare_contribution_yoy", + "headerName": "Acyclical Non-Health-Care Contribution (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "cyclical_inflation_mom", + "headerName": "Cyclical Inflation (MoM, AR)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_inflation_mom", + "headerName": "Acyclical Inflation (MoM, AR)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "cyclical_contribution_mom", + "headerName": "Cyclical Contribution (MoM, AR)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_contribution_mom", + "headerName": "Acyclical Contribution (MoM, AR)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_healthcare_contribution_mom", + "headerName": "Acyclical Health-Care Contribution (MoM, AR)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "acyclical_non_healthcare_contribution_mom", + "headerName": "Acyclical Non-Health-Care Contribution (MoM, AR)", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoCyclicalPce" + } + }, + "/federal_reserve/sf/supply_demand_pce": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed Supply & Demand-Driven PCE Inflation series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.supply_demand_pce(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoSupplyDemandPce", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "demand_core_yoy", + "type": "float | None", + "description": "Demand-driven core inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ambiguous_core_yoy", + "type": "float | None", + "description": "Ambiguous core inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "supply_core_yoy", + "type": "float | None", + "description": "Supply-driven core inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand_core_mom", + "type": "float | None", + "description": "Demand-driven core inflation, month-over-month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ambiguous_core_mom", + "type": "float | None", + "description": "Ambiguous core inflation, month-over-month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "supply_core_mom", + "type": "float | None", + "description": "Supply-driven core inflation, month-over-month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand_headline_yoy", + "type": "float | None", + "description": "Demand-driven headline inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ambiguous_headline_yoy", + "type": "float | None", + "description": "Ambiguous headline inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "supply_headline_yoy", + "type": "float | None", + "description": "Supply-driven headline inflation, year-over-year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand_headline_mom", + "type": "float | None", + "description": "Demand-driven headline inflation, month-over-month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ambiguous_headline_mom", + "type": "float | None", + "description": "Ambiguous headline inflation, month-over-month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "supply_headline_mom", + "type": "float | None", + "description": "Supply-driven headline inflation, month-over-month.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoSupplyDemandPce", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Supply & Demand-Driven PCE Inflation", + "description": "Monthly decomposition of core and headline PCE inflation into supply-driven, demand-driven, and ambiguous portions.", + "subCategory": "Inflation", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "demand_core_yoy", + "headerName": "Demand-Driven Core (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ambiguous_core_yoy", + "headerName": "Ambiguous Core (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "supply_core_yoy", + "headerName": "Supply-Driven Core (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "demand_core_mom", + "headerName": "Demand-Driven Core (MoM)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ambiguous_core_mom", + "headerName": "Ambiguous Core (MoM)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "supply_core_mom", + "headerName": "Supply-Driven Core (MoM)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "demand_headline_yoy", + "headerName": "Demand-Driven Headline (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ambiguous_headline_yoy", + "headerName": "Ambiguous Headline (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "supply_headline_yoy", + "headerName": "Supply-Driven Headline (YoY)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "demand_headline_mom", + "headerName": "Demand-Driven Headline (MoM)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "ambiguous_headline_mom", + "headerName": "Ambiguous Headline (MoM)", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "supply_headline_mom", + "headerName": "Supply-Driven Headline (MoM)", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoSupplyDemandPce" + } + }, + "/federal_reserve/sf/total_factor_productivity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed Quarterly TFP (Fernald) growth-accounting series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.total_factor_productivity(provider='federal_reserve')\n# Get the capital-input composition detail.\nobb.federal_reserve.sf.total_factor_productivity(table='capital_input_details', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "table", + "type": "str | None", + "description": "The quarterly growth-accounting series, its annualized counterpart, or the capital-input composition detail.", + "default": "quarterly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Quarterly", + "value": "quarterly" + }, + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Capital Input Details", + "value": "capital_input_details" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoTfp", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The period-end observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoTfp", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Quarterly TFP (Fernald)", + "description": "Fernald growth-accounting decomposition of U.S. business-sector output, including utilization-adjusted TFP, as annualized percent growth.", + "subCategory": "Activity & Productivity", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoTfp" + } + }, + "/federal_reserve/sf/term_premium": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed Treasury Term Premium decomposition.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.term_premium(provider='federal_reserve')\n# Get the two-year decomposition.\nobb.federal_reserve.sf.term_premium(maturity=2, provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "int | None", + "description": "The Treasury maturity, in years. One of 2 or 10.", + "default": 10, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "2-Year", + "value": 2 + }, + { + "label": "10-Year", + "value": 10 + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoTermPremium", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "yield_zero_coupon", + "type": "float | None", + "description": "The zero-coupon Treasury yield, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "expected_short_rate", + "type": "float | None", + "description": "The average expected short-rate component, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "term_premium", + "type": "float | None", + "description": "The term premium, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FederalReserveSanFranciscoTermPremium", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Treasury Term Premium", + "description": "Daily decomposition of the zero-coupon Treasury yield into the expected short-rate component and the term premium.", + "subCategory": "Rates & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "yield_zero_coupon", + "headerName": "Zero-Coupon Yield", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "expected_short_rate", + "headerName": "Expected Short Rate", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "term_premium", + "headerName": "Term Premium", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoTermPremium" + } + }, + "/federal_reserve/sf/short_rate_path": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the San Francisco Fed model-implied expected short-rate path by horizon.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.short_rate_path(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoShortRatePath", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "maturity", + "type": "float", + "description": "The horizon ahead, in years.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoShortRatePath", + "openapi_extra": { + "widget_config": { + "name": "SF Fed Estimated Short-Rate Path", + "description": "Model-implied expected path of the short-term interest rate by horizon, for the most-recent and FOMC scenarios.", + "subCategory": "Rates & Policy", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "maturity", + "headerName": "Maturity", + "cellDataType": "number", + "pinned": "left", + "sort": "asc" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoShortRatePath" + } + }, + "/federal_reserve/sf/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the San Francisco Fed Economic Letter and FedViews PDF archives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.publications(provider='federal_reserve')\n# Index the SF FedViews archive.\nobb.federal_reserve.sf.publications(publication_type='fedviews', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "FRBSF Economic Letter", + "value": "frbsf_economic_letter" + }, + { + "label": "Working Paper Series", + "value": "working_paper_series" + }, + { + "label": "Proceedings", + "value": "proceedings" + }, + { + "label": "Economic Review", + "value": "economic_review" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Community Development Innovation Review", + "value": "community_development_innovation_review" + }, + { + "label": "Community Investments", + "value": "community_investments" + }, + { + "label": "Working Papers in Applied Economic Theory", + "value": "working_papers_in_applied_economic_theory" + }, + { + "label": "Pacific Basin Working Paper Series", + "value": "pacific_basin_working_paper_series" + }, + { + "label": "Western economic developments", + "value": "western_economic_developments" + }, + { + "label": "Monograph", + "value": "monograph" + }, + { + "label": "Community Development Working Paper", + "value": "community_development_working_paper" + }, + { + "label": "Asia Focus", + "value": "asia_focus" + }, + { + "label": "Community Development Research Brief", + "value": "community_development_research_brief" + }, + { + "label": "Annual Report", + "value": "annual_report" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoPublications", + "openapi_extra": { + "model": "FederalReserveSanFranciscoPublications" + } + }, + "/federal_reserve/sf/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported San Francisco Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.sf.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveSanFranciscoPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveSanFranciscoPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "San Francisco Fed Publication Series", + "description": "The publication series supported by the San Francisco Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveSanFranciscoPublicationSeries" + } + }, + "/federal_reserve/stl/fred_md": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FRED-MD monthly macroeconomic database as a tidy long panel.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.stl.fred_md(provider='federal_reserve')\n# Return only selected series from the panel.\nobb.federal_reserve.stl.fred_md(series='INDPRO,UNRATE', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "One or more FRED series codes (panel columns) to return; the default returns every series. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Real Personal Income", + "value": "RPI" + }, + { + "label": "Real personal income ex transfer receipts", + "value": "W875RX1" + }, + { + "label": "Real personal consumption expenditures", + "value": "DPCERA3M086SBEA" + }, + { + "label": "Real Manu. and Trade Industries Sales", + "value": "CMRMTSPLx" + }, + { + "label": "Retail and Food Services Sales", + "value": "RETAILx" + }, + { + "label": "IP Index", + "value": "INDPRO" + }, + { + "label": "IP: Final Products and Nonindustrial Supplies", + "value": "IPFPNSS" + }, + { + "label": "IP: Final Products (Market Group)", + "value": "IPFINAL" + }, + { + "label": "IP: Consumer Goods", + "value": "IPCONGD" + }, + { + "label": "IP: Durable Consumer Goods", + "value": "IPDCONGD" + }, + { + "label": "IP: Nondurable Consumer Goods", + "value": "IPNCONGD" + }, + { + "label": "IP: Business Equipment", + "value": "IPBUSEQ" + }, + { + "label": "IP: Materials", + "value": "IPMAT" + }, + { + "label": "IP: Durable Materials", + "value": "IPDMAT" + }, + { + "label": "IP: Nondurable Materials", + "value": "IPNMAT" + }, + { + "label": "IP: Manufacturing (SIC)", + "value": "IPMANSICS" + }, + { + "label": "IP: Residential Utilities", + "value": "IPB51222S" + }, + { + "label": "IP: Fuels", + "value": "IPFUELS" + }, + { + "label": "Capacity Utilization: Manufacturing", + "value": "CUMFNS" + }, + { + "label": "Help-Wanted Index for United States", + "value": "HWI" + }, + { + "label": "Ratio of Help Wanted/No. Unemployed", + "value": "HWIURATIO" + }, + { + "label": "Civilian Labor Force", + "value": "CLF16OV" + }, + { + "label": "Civilian Employment", + "value": "CE16OV" + }, + { + "label": "Civilian Unemployment Rate", + "value": "UNRATE" + }, + { + "label": "Average Duration of Unemployment (Weeks)", + "value": "UEMPMEAN" + }, + { + "label": "Civilians Unemployed - Less Than 5 Weeks", + "value": "UEMPLT5" + }, + { + "label": "Civilians Unemployed for 5-14 Weeks", + "value": "UEMP5TO14" + }, + { + "label": "Civilians Unemployed - 15 Weeks & Over", + "value": "UEMP15OV" + }, + { + "label": "Civilians Unemployed for 15-26 Weeks", + "value": "UEMP15T26" + }, + { + "label": "Civilians Unemployed for 27 Weeks and Over", + "value": "UEMP27OV" + }, + { + "label": "Initial Claims", + "value": "CLAIMSx" + }, + { + "label": "All Employees: Total nonfarm", + "value": "PAYEMS" + }, + { + "label": "All Employees: Goods-Producing Industries", + "value": "USGOOD" + }, + { + "label": "All Employees: Mining and Logging: Mining", + "value": "CES1021000001" + }, + { + "label": "All Employees: Construction", + "value": "USCONS" + }, + { + "label": "All Employees: Manufacturing", + "value": "MANEMP" + }, + { + "label": "All Employees: Durable goods", + "value": "DMANEMP" + }, + { + "label": "All Employees: Nondurable goods", + "value": "NDMANEMP" + }, + { + "label": "All Employees: Service-Providing Industries", + "value": "SRVPRD" + }, + { + "label": "All Employees: Trade, Transportation & Utilities", + "value": "USTPU" + }, + { + "label": "All Employees: Wholesale Trade", + "value": "USWTRADE" + }, + { + "label": "All Employees: Retail Trade", + "value": "USTRADE" + }, + { + "label": "All Employees: Financial Activities", + "value": "USFIRE" + }, + { + "label": "All Employees: Government", + "value": "USGOVT" + }, + { + "label": "Avg Weekly Hours : Goods-Producing", + "value": "CES0600000007" + }, + { + "label": "Avg Weekly Overtime Hours : Manufacturing", + "value": "AWOTMAN" + }, + { + "label": "Avg Weekly Hours : Manufacturing", + "value": "AWHMAN" + }, + { + "label": "Housing Starts: Total New Privately Owned", + "value": "HOUST" + }, + { + "label": "Housing Starts, Northeast", + "value": "HOUSTNE" + }, + { + "label": "Housing Starts, Midwest", + "value": "HOUSTMW" + }, + { + "label": "Housing Starts, South", + "value": "HOUSTS" + }, + { + "label": "Housing Starts, West", + "value": "HOUSTW" + }, + { + "label": "New Private Housing Permits (SAAR)", + "value": "PERMIT" + }, + { + "label": "New Private Housing Permits, Northeast (SAAR)", + "value": "PERMITNE" + }, + { + "label": "New Private Housing Permits, Midwest (SAAR)", + "value": "PERMITMW" + }, + { + "label": "New Private Housing Permits, South (SAAR)", + "value": "PERMITS" + }, + { + "label": "New Private Housing Permits, West (SAAR)", + "value": "PERMITW" + }, + { + "label": "New Orders for Consumer Goods", + "value": "ACOGNO" + }, + { + "label": "New Orders for Durable Goods", + "value": "AMDMNOx" + }, + { + "label": "New Orders for Nondefense Capital Goods", + "value": "ANDENOx" + }, + { + "label": "Unfilled Orders for Durable Goods", + "value": "AMDMUOx" + }, + { + "label": "Total Business Inventories", + "value": "BUSINVx" + }, + { + "label": "Total Business: Inventories to Sales Ratio", + "value": "ISRATIOx" + }, + { + "label": "M1 Money Stock", + "value": "M1SL" + }, + { + "label": "M2 Money Stock", + "value": "M2SL" + }, + { + "label": "Real M2 Money Stock", + "value": "M2REAL" + }, + { + "label": "Monetary Base", + "value": "BOGMBASE" + }, + { + "label": "Total Reserves of Depository Institutions", + "value": "TOTRESNS" + }, + { + "label": "Reserves Of Depository Institutions", + "value": "NONBORRES" + }, + { + "label": "Commercial and Industrial Loans", + "value": "BUSLOANS" + }, + { + "label": "Real Estate Loans at All Commercial Banks", + "value": "REALLN" + }, + { + "label": "Total Nonrevolving Credit", + "value": "NONREVSL" + }, + { + "label": "Nonrevolving consumer credit to Personal Income", + "value": "CONSPI" + }, + { + "label": "S&P\u2019s Common Stock Price Index: Composite", + "value": "S&P 500" + }, + { + "label": "S&P\u2019s Composite Common Stock: Dividend Yield", + "value": "S&P div yield" + }, + { + "label": "S&P\u2019s Composite Common Stock: Price-Earnings Ratio", + "value": "S&P PE ratio" + }, + { + "label": "Effective Federal Funds Rate", + "value": "FEDFUNDS" + }, + { + "label": "3-Month AA Financial Commercial Paper Rate", + "value": "CP3Mx" + }, + { + "label": "3-Month Treasury Bill:", + "value": "TB3MS" + }, + { + "label": "6-Month Treasury Bill:", + "value": "TB6MS" + }, + { + "label": "1-Year Treasury Rate", + "value": "GS1" + }, + { + "label": "5-Year Treasury Rate", + "value": "GS5" + }, + { + "label": "10-Year Treasury Rate", + "value": "GS10" + }, + { + "label": "Moody\u2019s Seasoned Aaa Corporate Bond Yield", + "value": "AAA" + }, + { + "label": "Moody\u2019s Seasoned Baa Corporate Bond Yield", + "value": "BAA" + }, + { + "label": "3-Month Commercial Paper Minus FEDFUNDS", + "value": "COMPAPFFx" + }, + { + "label": "3-Month Treasury C Minus FEDFUNDS", + "value": "TB3SMFFM" + }, + { + "label": "6-Month Treasury C Minus FEDFUNDS", + "value": "TB6SMFFM" + }, + { + "label": "1-Year Treasury C Minus FEDFUNDS", + "value": "T1YFFM" + }, + { + "label": "5-Year Treasury C Minus FEDFUNDS", + "value": "T5YFFM" + }, + { + "label": "10-Year Treasury C Minus FEDFUNDS", + "value": "T10YFFM" + }, + { + "label": "Moody\u2019s Aaa Corporate Bond Minus FEDFUNDS", + "value": "AAAFFM" + }, + { + "label": "Moody's Baa Corporate Bond Minus FEDFUNDS", + "value": "BAAFFM" + }, + { + "label": "Trade Weighted U.S. Dollar Index", + "value": "TWEXAFEGSMTHx" + }, + { + "label": "Switzerland / U.S. Foreign Exchange Rate", + "value": "EXSZUSx" + }, + { + "label": "Japan / U.S. Foreign Exchange Rate", + "value": "EXJPUSx" + }, + { + "label": "U.S. / U.K. Foreign Exchange Rate", + "value": "EXUSUKx" + }, + { + "label": "Canada / U.S. Foreign Exchange Rate", + "value": "EXCAUSx" + }, + { + "label": "PPI: Finished Goods", + "value": "WPSFD49207" + }, + { + "label": "PPI: Finished Consumer Goods", + "value": "WPSFD49502" + }, + { + "label": "PPI: Intermediate Materials", + "value": "WPSID61" + }, + { + "label": "PPI: Crude Materials", + "value": "WPSID62" + }, + { + "label": "Crude Oil, spliced WTI and Cushing", + "value": "OILPRICEx" + }, + { + "label": "PPI: Metals and metal products:", + "value": "PPICMM" + }, + { + "label": "CPI : All Items", + "value": "CPIAUCSL" + }, + { + "label": "CPI : Apparel", + "value": "CPIAPPSL" + }, + { + "label": "CPI : Transportation", + "value": "CPITRNSL" + }, + { + "label": "CPI : Medical Care", + "value": "CPIMEDSL" + }, + { + "label": "CPI : Commodities", + "value": "CUSR0000SAC" + }, + { + "label": "CPI : Durables", + "value": "CUSR0000SAD" + }, + { + "label": "CPI : Services", + "value": "CUSR0000SAS" + }, + { + "label": "CPI : All Items Less Food", + "value": "CPIULFSL" + }, + { + "label": "CPI : All items less shelter", + "value": "CUSR0000SA0L2" + }, + { + "label": "CPI : All items less medical care", + "value": "CUSR0000SA0L5" + }, + { + "label": "Personal Cons. Expend.: Chain Index", + "value": "PCEPI" + }, + { + "label": "Personal Cons. Exp: Durable goods", + "value": "DDURRG3M086SBEA" + }, + { + "label": "Personal Cons. Exp: Nondurable goods", + "value": "DNDGRG3M086SBEA" + }, + { + "label": "Personal Cons. Exp: Services", + "value": "DSERRG3M086SBEA" + }, + { + "label": "Avg Hourly Earnings : Goods-Producing", + "value": "CES0600000008" + }, + { + "label": "Avg Hourly Earnings : Construction", + "value": "CES2000000008" + }, + { + "label": "Avg Hourly Earnings : Manufacturing", + "value": "CES3000000008" + }, + { + "label": "Consumer Sentiment Index", + "value": "UMCSENTx" + }, + { + "label": "Consumer Motor Vehicle Loans Outstanding", + "value": "DTCOLNVHFNM" + }, + { + "label": "Total Consumer Loans and Leases Outstanding", + "value": "DTCTHFNM" + }, + { + "label": "Securities in Bank Credit at All Commercial Banks", + "value": "INVEST" + }, + { + "label": "VIX", + "value": "VIXCLSx" + } + ], + "multiSelect": true + } + } + }, + { + "name": "transform", + "type": "bool | None", + "description": "Apply each series' recommended stationarity transformation (its transform code) instead of returning raw levels.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveStLouisFredMd", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveStLouisFredMd", + "openapi_extra": { + "widget_config": { + "name": "FRED-MD Monthly Macro Panel, St. Louis Fed", + "description": "The McCracken-Ng monthly database of 120+ U.S. macroeconomic series as a wide panel, one column per series.", + "subCategory": "Macro Data Panels", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "RPI", + "headerName": "Real Personal Income", + "headerTooltip": "RPI", + "cellDataType": "number" + }, + { + "field": "W875RX1", + "headerName": "Real personal income ex transfer receipts", + "headerTooltip": "W875RX1", + "cellDataType": "number" + }, + { + "field": "DPCERA3M086SBEA", + "headerName": "Real personal consumption expenditures", + "headerTooltip": "DPCERA3M086SBEA", + "cellDataType": "number" + }, + { + "field": "CMRMTSPLx", + "headerName": "Real Manu. and Trade Industries Sales", + "headerTooltip": "CMRMTSPLx", + "cellDataType": "number" + }, + { + "field": "RETAILx", + "headerName": "Retail and Food Services Sales", + "headerTooltip": "RETAILx", + "cellDataType": "number" + }, + { + "field": "INDPRO", + "headerName": "IP Index", + "headerTooltip": "INDPRO", + "cellDataType": "number" + }, + { + "field": "IPFPNSS", + "headerName": "IP: Final Products and Nonindustrial Supplies", + "headerTooltip": "IPFPNSS", + "cellDataType": "number" + }, + { + "field": "IPFINAL", + "headerName": "IP: Final Products (Market Group)", + "headerTooltip": "IPFINAL", + "cellDataType": "number" + }, + { + "field": "IPCONGD", + "headerName": "IP: Consumer Goods", + "headerTooltip": "IPCONGD", + "cellDataType": "number" + }, + { + "field": "IPDCONGD", + "headerName": "IP: Durable Consumer Goods", + "headerTooltip": "IPDCONGD", + "cellDataType": "number" + }, + { + "field": "IPNCONGD", + "headerName": "IP: Nondurable Consumer Goods", + "headerTooltip": "IPNCONGD", + "cellDataType": "number" + }, + { + "field": "IPBUSEQ", + "headerName": "IP: Business Equipment", + "headerTooltip": "IPBUSEQ", + "cellDataType": "number" + }, + { + "field": "IPMAT", + "headerName": "IP: Materials", + "headerTooltip": "IPMAT", + "cellDataType": "number" + }, + { + "field": "IPDMAT", + "headerName": "IP: Durable Materials", + "headerTooltip": "IPDMAT", + "cellDataType": "number" + }, + { + "field": "IPNMAT", + "headerName": "IP: Nondurable Materials", + "headerTooltip": "IPNMAT", + "cellDataType": "number" + }, + { + "field": "IPMANSICS", + "headerName": "IP: Manufacturing (SIC)", + "headerTooltip": "IPMANSICS", + "cellDataType": "number" + }, + { + "field": "IPB51222S", + "headerName": "IP: Residential Utilities", + "headerTooltip": "IPB51222S", + "cellDataType": "number" + }, + { + "field": "IPFUELS", + "headerName": "IP: Fuels", + "headerTooltip": "IPFUELS", + "cellDataType": "number" + }, + { + "field": "CUMFNS", + "headerName": "Capacity Utilization: Manufacturing", + "headerTooltip": "CUMFNS", + "cellDataType": "number" + }, + { + "field": "HWI", + "headerName": "Help-Wanted Index for United States", + "headerTooltip": "HWI", + "cellDataType": "number" + }, + { + "field": "HWIURATIO", + "headerName": "Ratio of Help Wanted/No. Unemployed", + "headerTooltip": "HWIURATIO", + "cellDataType": "number" + }, + { + "field": "CLF16OV", + "headerName": "Civilian Labor Force", + "headerTooltip": "CLF16OV", + "cellDataType": "number" + }, + { + "field": "CE16OV", + "headerName": "Civilian Employment", + "headerTooltip": "CE16OV", + "cellDataType": "number" + }, + { + "field": "UNRATE", + "headerName": "Civilian Unemployment Rate", + "headerTooltip": "UNRATE", + "cellDataType": "number" + }, + { + "field": "UEMPMEAN", + "headerName": "Average Duration of Unemployment (Weeks)", + "headerTooltip": "UEMPMEAN", + "cellDataType": "number" + }, + { + "field": "UEMPLT5", + "headerName": "Civilians Unemployed - Less Than 5 Weeks", + "headerTooltip": "UEMPLT5", + "cellDataType": "number" + }, + { + "field": "UEMP5TO14", + "headerName": "Civilians Unemployed for 5-14 Weeks", + "headerTooltip": "UEMP5TO14", + "cellDataType": "number" + }, + { + "field": "UEMP15OV", + "headerName": "Civilians Unemployed - 15 Weeks & Over", + "headerTooltip": "UEMP15OV", + "cellDataType": "number" + }, + { + "field": "UEMP15T26", + "headerName": "Civilians Unemployed for 15-26 Weeks", + "headerTooltip": "UEMP15T26", + "cellDataType": "number" + }, + { + "field": "UEMP27OV", + "headerName": "Civilians Unemployed for 27 Weeks and Over", + "headerTooltip": "UEMP27OV", + "cellDataType": "number" + }, + { + "field": "CLAIMSx", + "headerName": "Initial Claims", + "headerTooltip": "CLAIMSx", + "cellDataType": "number" + }, + { + "field": "PAYEMS", + "headerName": "All Employees: Total nonfarm", + "headerTooltip": "PAYEMS", + "cellDataType": "number" + }, + { + "field": "USGOOD", + "headerName": "All Employees: Goods-Producing Industries", + "headerTooltip": "USGOOD", + "cellDataType": "number" + }, + { + "field": "CES1021000001", + "headerName": "All Employees: Mining and Logging: Mining", + "headerTooltip": "CES1021000001", + "cellDataType": "number" + }, + { + "field": "USCONS", + "headerName": "All Employees: Construction", + "headerTooltip": "USCONS", + "cellDataType": "number" + }, + { + "field": "MANEMP", + "headerName": "All Employees: Manufacturing", + "headerTooltip": "MANEMP", + "cellDataType": "number" + }, + { + "field": "DMANEMP", + "headerName": "All Employees: Durable goods", + "headerTooltip": "DMANEMP", + "cellDataType": "number" + }, + { + "field": "NDMANEMP", + "headerName": "All Employees: Nondurable goods", + "headerTooltip": "NDMANEMP", + "cellDataType": "number" + }, + { + "field": "SRVPRD", + "headerName": "All Employees: Service-Providing Industries", + "headerTooltip": "SRVPRD", + "cellDataType": "number" + }, + { + "field": "USTPU", + "headerName": "All Employees: Trade, Transportation & Utilities", + "headerTooltip": "USTPU", + "cellDataType": "number" + }, + { + "field": "USWTRADE", + "headerName": "All Employees: Wholesale Trade", + "headerTooltip": "USWTRADE", + "cellDataType": "number" + }, + { + "field": "USTRADE", + "headerName": "All Employees: Retail Trade", + "headerTooltip": "USTRADE", + "cellDataType": "number" + }, + { + "field": "USFIRE", + "headerName": "All Employees: Financial Activities", + "headerTooltip": "USFIRE", + "cellDataType": "number" + }, + { + "field": "USGOVT", + "headerName": "All Employees: Government", + "headerTooltip": "USGOVT", + "cellDataType": "number" + }, + { + "field": "CES0600000007", + "headerName": "Avg Weekly Hours : Goods-Producing", + "headerTooltip": "CES0600000007", + "cellDataType": "number" + }, + { + "field": "AWOTMAN", + "headerName": "Avg Weekly Overtime Hours : Manufacturing", + "headerTooltip": "AWOTMAN", + "cellDataType": "number" + }, + { + "field": "AWHMAN", + "headerName": "Avg Weekly Hours : Manufacturing", + "headerTooltip": "AWHMAN", + "cellDataType": "number" + }, + { + "field": "HOUST", + "headerName": "Housing Starts: Total New Privately Owned", + "headerTooltip": "HOUST", + "cellDataType": "number" + }, + { + "field": "HOUSTNE", + "headerName": "Housing Starts, Northeast", + "headerTooltip": "HOUSTNE", + "cellDataType": "number" + }, + { + "field": "HOUSTMW", + "headerName": "Housing Starts, Midwest", + "headerTooltip": "HOUSTMW", + "cellDataType": "number" + }, + { + "field": "HOUSTS", + "headerName": "Housing Starts, South", + "headerTooltip": "HOUSTS", + "cellDataType": "number" + }, + { + "field": "HOUSTW", + "headerName": "Housing Starts, West", + "headerTooltip": "HOUSTW", + "cellDataType": "number" + }, + { + "field": "PERMIT", + "headerName": "New Private Housing Permits (SAAR)", + "headerTooltip": "PERMIT", + "cellDataType": "number" + }, + { + "field": "PERMITNE", + "headerName": "New Private Housing Permits, Northeast (SAAR)", + "headerTooltip": "PERMITNE", + "cellDataType": "number" + }, + { + "field": "PERMITMW", + "headerName": "New Private Housing Permits, Midwest (SAAR)", + "headerTooltip": "PERMITMW", + "cellDataType": "number" + }, + { + "field": "PERMITS", + "headerName": "New Private Housing Permits, South (SAAR)", + "headerTooltip": "PERMITS", + "cellDataType": "number" + }, + { + "field": "PERMITW", + "headerName": "New Private Housing Permits, West (SAAR)", + "headerTooltip": "PERMITW", + "cellDataType": "number" + }, + { + "field": "ACOGNO", + "headerName": "New Orders for Consumer Goods", + "headerTooltip": "ACOGNO", + "cellDataType": "number" + }, + { + "field": "AMDMNOx", + "headerName": "New Orders for Durable Goods", + "headerTooltip": "AMDMNOx", + "cellDataType": "number" + }, + { + "field": "ANDENOx", + "headerName": "New Orders for Nondefense Capital Goods", + "headerTooltip": "ANDENOx", + "cellDataType": "number" + }, + { + "field": "AMDMUOx", + "headerName": "Unfilled Orders for Durable Goods", + "headerTooltip": "AMDMUOx", + "cellDataType": "number" + }, + { + "field": "BUSINVx", + "headerName": "Total Business Inventories", + "headerTooltip": "BUSINVx", + "cellDataType": "number" + }, + { + "field": "ISRATIOx", + "headerName": "Total Business: Inventories to Sales Ratio", + "headerTooltip": "ISRATIOx", + "cellDataType": "number" + }, + { + "field": "M1SL", + "headerName": "M1 Money Stock", + "headerTooltip": "M1SL", + "cellDataType": "number" + }, + { + "field": "M2SL", + "headerName": "M2 Money Stock", + "headerTooltip": "M2SL", + "cellDataType": "number" + }, + { + "field": "M2REAL", + "headerName": "Real M2 Money Stock", + "headerTooltip": "M2REAL", + "cellDataType": "number" + }, + { + "field": "BOGMBASE", + "headerName": "Monetary Base", + "headerTooltip": "BOGMBASE", + "cellDataType": "number" + }, + { + "field": "TOTRESNS", + "headerName": "Total Reserves of Depository Institutions", + "headerTooltip": "TOTRESNS", + "cellDataType": "number" + }, + { + "field": "NONBORRES", + "headerName": "Reserves Of Depository Institutions", + "headerTooltip": "NONBORRES", + "cellDataType": "number" + }, + { + "field": "BUSLOANS", + "headerName": "Commercial and Industrial Loans", + "headerTooltip": "BUSLOANS", + "cellDataType": "number" + }, + { + "field": "REALLN", + "headerName": "Real Estate Loans at All Commercial Banks", + "headerTooltip": "REALLN", + "cellDataType": "number" + }, + { + "field": "NONREVSL", + "headerName": "Total Nonrevolving Credit", + "headerTooltip": "NONREVSL", + "cellDataType": "number" + }, + { + "field": "CONSPI", + "headerName": "Nonrevolving consumer credit to Personal Income", + "headerTooltip": "CONSPI", + "cellDataType": "number" + }, + { + "field": "S&P 500", + "headerName": "S&P\u2019s Common Stock Price Index: Composite", + "headerTooltip": "S&P 500", + "cellDataType": "number" + }, + { + "field": "S&P div yield", + "headerName": "S&P\u2019s Composite Common Stock: Dividend Yield", + "headerTooltip": "S&P div yield", + "cellDataType": "number" + }, + { + "field": "S&P PE ratio", + "headerName": "S&P\u2019s Composite Common Stock: Price-Earnings Ratio", + "headerTooltip": "S&P PE ratio", + "cellDataType": "number" + }, + { + "field": "FEDFUNDS", + "headerName": "Effective Federal Funds Rate", + "headerTooltip": "FEDFUNDS", + "cellDataType": "number" + }, + { + "field": "CP3Mx", + "headerName": "3-Month AA Financial Commercial Paper Rate", + "headerTooltip": "CP3Mx", + "cellDataType": "number" + }, + { + "field": "TB3MS", + "headerName": "3-Month Treasury Bill:", + "headerTooltip": "TB3MS", + "cellDataType": "number" + }, + { + "field": "TB6MS", + "headerName": "6-Month Treasury Bill:", + "headerTooltip": "TB6MS", + "cellDataType": "number" + }, + { + "field": "GS1", + "headerName": "1-Year Treasury Rate", + "headerTooltip": "GS1", + "cellDataType": "number" + }, + { + "field": "GS5", + "headerName": "5-Year Treasury Rate", + "headerTooltip": "GS5", + "cellDataType": "number" + }, + { + "field": "GS10", + "headerName": "10-Year Treasury Rate", + "headerTooltip": "GS10", + "cellDataType": "number" + }, + { + "field": "AAA", + "headerName": "Moody\u2019s Seasoned Aaa Corporate Bond Yield", + "headerTooltip": "AAA", + "cellDataType": "number" + }, + { + "field": "BAA", + "headerName": "Moody\u2019s Seasoned Baa Corporate Bond Yield", + "headerTooltip": "BAA", + "cellDataType": "number" + }, + { + "field": "COMPAPFFx", + "headerName": "3-Month Commercial Paper Minus FEDFUNDS", + "headerTooltip": "COMPAPFFx", + "cellDataType": "number" + }, + { + "field": "TB3SMFFM", + "headerName": "3-Month Treasury C Minus FEDFUNDS", + "headerTooltip": "TB3SMFFM", + "cellDataType": "number" + }, + { + "field": "TB6SMFFM", + "headerName": "6-Month Treasury C Minus FEDFUNDS", + "headerTooltip": "TB6SMFFM", + "cellDataType": "number" + }, + { + "field": "T1YFFM", + "headerName": "1-Year Treasury C Minus FEDFUNDS", + "headerTooltip": "T1YFFM", + "cellDataType": "number" + }, + { + "field": "T5YFFM", + "headerName": "5-Year Treasury C Minus FEDFUNDS", + "headerTooltip": "T5YFFM", + "cellDataType": "number" + }, + { + "field": "T10YFFM", + "headerName": "10-Year Treasury C Minus FEDFUNDS", + "headerTooltip": "T10YFFM", + "cellDataType": "number" + }, + { + "field": "AAAFFM", + "headerName": "Moody\u2019s Aaa Corporate Bond Minus FEDFUNDS", + "headerTooltip": "AAAFFM", + "cellDataType": "number" + }, + { + "field": "BAAFFM", + "headerName": "Moody's Baa Corporate Bond Minus FEDFUNDS", + "headerTooltip": "BAAFFM", + "cellDataType": "number" + }, + { + "field": "TWEXAFEGSMTHx", + "headerName": "Trade Weighted U.S. Dollar Index", + "headerTooltip": "TWEXAFEGSMTHx", + "cellDataType": "number" + }, + { + "field": "EXSZUSx", + "headerName": "Switzerland / U.S. Foreign Exchange Rate", + "headerTooltip": "EXSZUSx", + "cellDataType": "number" + }, + { + "field": "EXJPUSx", + "headerName": "Japan / U.S. Foreign Exchange Rate", + "headerTooltip": "EXJPUSx", + "cellDataType": "number" + }, + { + "field": "EXUSUKx", + "headerName": "U.S. / U.K. Foreign Exchange Rate", + "headerTooltip": "EXUSUKx", + "cellDataType": "number" + }, + { + "field": "EXCAUSx", + "headerName": "Canada / U.S. Foreign Exchange Rate", + "headerTooltip": "EXCAUSx", + "cellDataType": "number" + }, + { + "field": "WPSFD49207", + "headerName": "PPI: Finished Goods", + "headerTooltip": "WPSFD49207", + "cellDataType": "number" + }, + { + "field": "WPSFD49502", + "headerName": "PPI: Finished Consumer Goods", + "headerTooltip": "WPSFD49502", + "cellDataType": "number" + }, + { + "field": "WPSID61", + "headerName": "PPI: Intermediate Materials", + "headerTooltip": "WPSID61", + "cellDataType": "number" + }, + { + "field": "WPSID62", + "headerName": "PPI: Crude Materials", + "headerTooltip": "WPSID62", + "cellDataType": "number" + }, + { + "field": "OILPRICEx", + "headerName": "Crude Oil, spliced WTI and Cushing", + "headerTooltip": "OILPRICEx", + "cellDataType": "number" + }, + { + "field": "PPICMM", + "headerName": "PPI: Metals and metal products:", + "headerTooltip": "PPICMM", + "cellDataType": "number" + }, + { + "field": "CPIAUCSL", + "headerName": "CPI : All Items", + "headerTooltip": "CPIAUCSL", + "cellDataType": "number" + }, + { + "field": "CPIAPPSL", + "headerName": "CPI : Apparel", + "headerTooltip": "CPIAPPSL", + "cellDataType": "number" + }, + { + "field": "CPITRNSL", + "headerName": "CPI : Transportation", + "headerTooltip": "CPITRNSL", + "cellDataType": "number" + }, + { + "field": "CPIMEDSL", + "headerName": "CPI : Medical Care", + "headerTooltip": "CPIMEDSL", + "cellDataType": "number" + }, + { + "field": "CUSR0000SAC", + "headerName": "CPI : Commodities", + "headerTooltip": "CUSR0000SAC", + "cellDataType": "number" + }, + { + "field": "CUSR0000SAD", + "headerName": "CPI : Durables", + "headerTooltip": "CUSR0000SAD", + "cellDataType": "number" + }, + { + "field": "CUSR0000SAS", + "headerName": "CPI : Services", + "headerTooltip": "CUSR0000SAS", + "cellDataType": "number" + }, + { + "field": "CPIULFSL", + "headerName": "CPI : All Items Less Food", + "headerTooltip": "CPIULFSL", + "cellDataType": "number" + }, + { + "field": "CUSR0000SA0L2", + "headerName": "CPI : All items less shelter", + "headerTooltip": "CUSR0000SA0L2", + "cellDataType": "number" + }, + { + "field": "CUSR0000SA0L5", + "headerName": "CPI : All items less medical care", + "headerTooltip": "CUSR0000SA0L5", + "cellDataType": "number" + }, + { + "field": "PCEPI", + "headerName": "Personal Cons. Expend.: Chain Index", + "headerTooltip": "PCEPI", + "cellDataType": "number" + }, + { + "field": "DDURRG3M086SBEA", + "headerName": "Personal Cons. Exp: Durable goods", + "headerTooltip": "DDURRG3M086SBEA", + "cellDataType": "number" + }, + { + "field": "DNDGRG3M086SBEA", + "headerName": "Personal Cons. Exp: Nondurable goods", + "headerTooltip": "DNDGRG3M086SBEA", + "cellDataType": "number" + }, + { + "field": "DSERRG3M086SBEA", + "headerName": "Personal Cons. Exp: Services", + "headerTooltip": "DSERRG3M086SBEA", + "cellDataType": "number" + }, + { + "field": "CES0600000008", + "headerName": "Avg Hourly Earnings : Goods-Producing", + "headerTooltip": "CES0600000008", + "cellDataType": "number" + }, + { + "field": "CES2000000008", + "headerName": "Avg Hourly Earnings : Construction", + "headerTooltip": "CES2000000008", + "cellDataType": "number" + }, + { + "field": "CES3000000008", + "headerName": "Avg Hourly Earnings : Manufacturing", + "headerTooltip": "CES3000000008", + "cellDataType": "number" + }, + { + "field": "UMCSENTx", + "headerName": "Consumer Sentiment Index", + "headerTooltip": "UMCSENTx", + "cellDataType": "number" + }, + { + "field": "DTCOLNVHFNM", + "headerName": "Consumer Motor Vehicle Loans Outstanding", + "headerTooltip": "DTCOLNVHFNM", + "cellDataType": "number" + }, + { + "field": "DTCTHFNM", + "headerName": "Total Consumer Loans and Leases Outstanding", + "headerTooltip": "DTCTHFNM", + "cellDataType": "number" + }, + { + "field": "INVEST", + "headerName": "Securities in Bank Credit at All Commercial Banks", + "headerTooltip": "INVEST", + "cellDataType": "number" + }, + { + "field": "VIXCLSx", + "headerName": "VIX", + "headerTooltip": "VIXCLSx", + "cellDataType": "number" + } + ] + } + } + }, + "model": "FederalReserveStLouisFredMd" + } + }, + "/federal_reserve/stl/publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the supported St. Louis Fed publication series and their document counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.stl.publication_series(provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveStLouisPublicationSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str", + "description": "The series slug used to filter the publications catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The human-readable series name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "count", + "type": "int", + "description": "The number of documents published in the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveStLouisPublicationSeries", + "openapi_extra": { + "widget_config": { + "name": "St. Louis Fed Publication Series", + "description": "The publication series supported by the St. Louis Fed publications catalog, with the document count in each.", + "subCategory": "Publications & Reports", + "gridData": { + "w": 20, + "h": 15 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "name", + "headerName": "Series" + }, + { + "field": "series", + "headerName": "Slug" + }, + { + "field": "count", + "headerName": "Documents" + } + ] + } + } + }, + "model": "FederalReserveStLouisPublicationSeries" + } + }, + "/federal_reserve/stl/fred_qd": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the FRED-QD quarterly macroeconomic database as a tidy long panel.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.stl.fred_qd(provider='federal_reserve')\n# Return only selected series from the panel.\nobb.federal_reserve.stl.fred_qd(series='GDPC1,PCECC96', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "One or more FRED series codes (panel columns) to return; the default returns every series. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Real Gross Domestic Product, 3 Decimal (Billions of Chained 2017 Dollars)", + "value": "GDPC1" + }, + { + "label": "Real Personal Consumption Expenditures (Billions of Chained 2017 Dollars)", + "value": "PCECC96" + }, + { + "label": "Real personal consumption expenditures: Durable goods (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "PCDGx" + }, + { + "label": "Real Personal Consumption Expenditures: Services (Billions of 2017 Dollars), deflated using its own price index", + "value": "PCESVx" + }, + { + "label": "Real Personal Consumption Expenditures: Nondurable Goods (Billions of 2017 Dollars), deflated using its own price index", + "value": "PCNDx" + }, + { + "label": "Real Gross Private Domestic Investment, 3 decimal (Billions of Chained 2017 Dollars)", + "value": "GPDIC1" + }, + { + "label": "Real private fixed investment (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "FPIx" + }, + { + "label": "Real Gross Private Domestic Investment: Fixed Investment: Nonresidential: Equipment (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "Y033RC1Q027SBEAx" + }, + { + "label": "Real private fixed investment: Nonresidential (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "PNFIx" + }, + { + "label": "Real private fixed investment: Residential (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "PRFIx" + }, + { + "label": "Shares of gross domestic product: Gross private domestic investment: Change in private inventories (Percent)", + "value": "A014RE1Q156NBEA" + }, + { + "label": "Real Government Consumption Expenditures & Gross Investment (Billions of Chained 2017 Dollars)", + "value": "GCEC1" + }, + { + "label": "Real Government Consumption Expenditures and Gross Investment: Federal (Percent Change from Preceding Period)", + "value": "A823RL1Q225SBEA" + }, + { + "label": "Real Federal Government Current Receipts (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "FGRECPTx" + }, + { + "label": "Real government state and local consumption expenditures (Billions of Chained 2017 Dollars), deflated using its own price index", + "value": "SLCEx" + }, + { + "label": "Real Exports of Goods & Services, 3 Decimal (Billions of Chained 2017 Dollars)", + "value": "EXPGSC1" + }, + { + "label": "Real Imports of Goods & Services, 3 Decimal (Billions of Chained 2017 Dollars)", + "value": "IMPGSC1" + }, + { + "label": "Real Disposable Personal Income (Billions of Chained 2017 Dollars)", + "value": "DPIC96" + }, + { + "label": "Nonfarm Business Sector: Real Output (Index 2017=100)", + "value": "OUTNFB" + }, + { + "label": "Business Sector: Real Output (Index 2017=100)", + "value": "OUTBS" + }, + { + "label": "Manufacturing Sector: Real Output (Index 2017=100)", + "value": "OUTMS" + }, + { + "label": "Industrial Production Index (Index 2017=100)", + "value": "INDPRO" + }, + { + "label": "Industrial Production: Final Products (Market Group) (Index 2017=100)", + "value": "IPFINAL" + }, + { + "label": "Industrial Production: Consumer Goods (Index 2017=100)", + "value": "IPCONGD" + }, + { + "label": "Industrial Production: Materials (Index 2017=100)", + "value": "IPMAT" + }, + { + "label": "Industrial Production: Durable Materials (Index 2017=100)", + "value": "IPDMAT" + }, + { + "label": "Industrial Production: Nondurable Materials (Index 2017=100)", + "value": "IPNMAT" + }, + { + "label": "Industrial Production: Durable Consumer Goods (Index 2017=100)", + "value": "IPDCONGD" + }, + { + "label": "Industrial Production: Durable Goods: Automotive products (Index 2017=100)", + "value": "IPB51110SQ" + }, + { + "label": "Industrial Production: Nondurable Consumer Goods (Index 2017=100)", + "value": "IPNCONGD" + }, + { + "label": "Industrial Production: Business Equipment (Index 2017=100)", + "value": "IPBUSEQ" + }, + { + "label": "Industrial Production: Consumer energy products (Index 2017=100)", + "value": "IPB51220SQ" + }, + { + "label": "Capacity Utilization: Total Industry (Percent of Capacity)", + "value": "TCU" + }, + { + "label": "Capacity Utilization: Manufacturing (SIC) (Percent of Capacity)", + "value": "CUMFNS" + }, + { + "label": "All Employees: Total nonfarm (Thousands of Persons)", + "value": "PAYEMS" + }, + { + "label": "All Employees: Total Private Industries (Thousands of Persons)", + "value": "USPRIV" + }, + { + "label": "All Employees: Manufacturing (Thousands of Persons)", + "value": "MANEMP" + }, + { + "label": "All Employees: Service-Providing Industries (Thousands of Persons)", + "value": "SRVPRD" + }, + { + "label": "All Employees: Goods-Producing Industries (Thousands of Persons)", + "value": "USGOOD" + }, + { + "label": "All Employees: Durable goods (Thousands of Persons)", + "value": "DMANEMP" + }, + { + "label": "All Employees: Nondurable goods (Thousands of Persons)", + "value": "NDMANEMP" + }, + { + "label": "All Employees: Construction (Thousands of Persons)", + "value": "USCONS" + }, + { + "label": "All Employees: Education & Health Services (Thousands of Persons)", + "value": "USEHS" + }, + { + "label": "All Employees: Financial Activities (Thousands of Persons)", + "value": "USFIRE" + }, + { + "label": "All Employees: Information Services (Thousands of Persons)", + "value": "USINFO" + }, + { + "label": "All Employees: Professional & Business Services (Thousands of Persons)", + "value": "USPBS" + }, + { + "label": "All Employees: Leisure & Hospitality (Thousands of Persons)", + "value": "USLAH" + }, + { + "label": "All Employees: Other Services (Thousands of Persons)", + "value": "USSERV" + }, + { + "label": "All Employees: Mining and logging (Thousands of Persons)", + "value": "USMINE" + }, + { + "label": "All Employees: Trade, Transportation & Utilities (Thousands of Persons)", + "value": "USTPU" + }, + { + "label": "All Employees: Government (Thousands of Persons)", + "value": "USGOVT" + }, + { + "label": "All Employees: Retail Trade (Thousands of Persons)", + "value": "USTRADE" + }, + { + "label": "All Employees: Wholesale Trade (Thousands of Persons)", + "value": "USWTRADE" + }, + { + "label": "All Employees: Government: Federal (Thousands of Persons)", + "value": "CES9091000001" + }, + { + "label": "All Employees: Government: State Government (Thousands of Persons)", + "value": "CES9092000001" + }, + { + "label": "All Employees: Government: Local Government (Thousands of Persons)", + "value": "CES9093000001" + }, + { + "label": "Civilian Employment (Thousands of Persons)", + "value": "CE16OV" + }, + { + "label": "Civilian Labor Force Participation Rate (Percent)", + "value": "CIVPART" + }, + { + "label": "Civilian Unemployment Rate (Percent)", + "value": "UNRATE" + }, + { + "label": "Unemployment Rate less than 27 weeks (Percent)", + "value": "UNRATESTx" + }, + { + "label": "Unemployment Rate for more than 27 weeks (Percent)", + "value": "UNRATELTx" + }, + { + "label": "Unemployment Rate - 16 to 19 years (Percent)", + "value": "LNS14000012" + }, + { + "label": "Unemployment Rate - 20 years and over, Men (Percent)", + "value": "LNS14000025" + }, + { + "label": "Unemployment Rate - 20 years and over, Women (Percent)", + "value": "LNS14000026" + }, + { + "label": "Number of Civilians Unemployed - Less Than 5 Weeks (Thousands of Persons)", + "value": "UEMPLT5" + }, + { + "label": "Number of Civilians Unemployed for 5 to 14 Weeks (Thousands of Persons)", + "value": "UEMP5TO14" + }, + { + "label": "Number of Civilians Unemployed for 15 to 26 Weeks (Thousands of Persons)", + "value": "UEMP15T26" + }, + { + "label": "Number of Civilians Unemployed for 27 Weeks and Over (Thousands of Persons)", + "value": "UEMP27OV" + }, + { + "label": "Unemployment Level - Job Losers (Thousands of Persons)", + "value": "LNS13023621" + }, + { + "label": "Unemployment Level - Reentrants to Labor Force (Thousands of Persons)", + "value": "LNS13023557" + }, + { + "label": "Unemployment Level - Job Leavers (Thousands of Persons)", + "value": "LNS13023705" + }, + { + "label": "Unemployment Level - New Entrants (Thousands of Persons)", + "value": "LNS13023569" + }, + { + "label": "Employment Level - Part-Time for Economic Reasons, All Industries (Thousands of Persons)", + "value": "LNS12032194" + }, + { + "label": "Business Sector: Hours of All Persons (Index 2017=100)", + "value": "HOABS" + }, + { + "label": "Manufacturing Sector: Hours of All Persons (Index 2017=100)", + "value": "HOAMS" + }, + { + "label": "Nonfarm Business Sector: Hours of All Persons (Index 2017=100)", + "value": "HOANBS" + }, + { + "label": "Average Weekly Hours of Production and Nonsupervisory Employees: Manufacturing (Hours)", + "value": "AWHMAN" + }, + { + "label": "Average Weekly Hours Of Production And Nonsupervisory Employees: Total private (Hours)", + "value": "AWHNONAG" + }, + { + "label": "Average Weekly Overtime Hours of Production and Nonsupervisory Employees: Manufacturing (Hours)", + "value": "AWOTMAN" + }, + { + "label": "Help-Wanted Index", + "value": "HWIx" + }, + { + "label": "Housing Starts: Total: New Privately Owned Housing Units Started (Thousands of Units)", + "value": "HOUST" + }, + { + "label": "Privately Owned Housing Starts: 5-Unit Structures or More (Thousands of Units)", + "value": "HOUST5F" + }, + { + "label": "New Private Housing Units Authorized by Building Permits (Thousands of Units)", + "value": "PERMIT" + }, + { + "label": "Housing Starts in Midwest Census Region (Thousands of Units)", + "value": "HOUSTMW" + }, + { + "label": "Housing Starts in Northeast Census Region (Thousands of Units)", + "value": "HOUSTNE" + }, + { + "label": "Housing Starts in South Census Region (Thousands of Units)", + "value": "HOUSTS" + }, + { + "label": "Housing Starts in West Census Region (Thousands of Units)", + "value": "HOUSTW" + }, + { + "label": "Real Manufacturing and Trade Industries Sales (Millions of Chained 2017 Dollars)", + "value": "CMRMTSPLx" + }, + { + "label": "Real Retail and Food Services Sales (Millions of Chained 2017 Dollars), deflated by Core PCE", + "value": "RSAFSx" + }, + { + "label": "Real Manufacturers' New Orders: Durable Goods (Millions of 2017 Dollars), deflated by Core PCE", + "value": "AMDMNOx" + }, + { + "label": "Real Value of Manufacturers' New Orders for Consumer Goods Industries (Million of 2017 Dollars), deflated by Core PCE", + "value": "ACOGNOx" + }, + { + "label": "Real Value of Manufacturers' Unfilled Orders for Durable Goods Industries (Million of 2017 Dollars), deflated by Core PCE", + "value": "AMDMUOx" + }, + { + "label": "Real Value of Manufacturers' New Orders for Capital Goods: Nondefense Capital Goods Industries (Million of 2017 Dollars), deflated by Core PCE", + "value": "ANDENOx" + }, + { + "label": "Real Manufacturing and Trade Inventories (Millions of 2017 Dollars)", + "value": "INVCQRMTSPL" + }, + { + "label": "Personal Consumption Expenditures: Chain-type Price Index (Index 2017=100)", + "value": "PCECTPI" + }, + { + "label": "Personal Consumption Expenditures Excluding Food and Energy (Chain-Type Price Index) (Index 2017=100)", + "value": "PCEPILFE" + }, + { + "label": "Gross Domestic Product: Chain-type Price Index (Index 2017=100)", + "value": "GDPCTPI" + }, + { + "label": "Gross Private Domestic Investment: Chain-type Price Index (Index 2017=100)", + "value": "GPDICTPI" + }, + { + "label": "Business Sector: Implicit Price Deflator (Index 2017=100)", + "value": "IPDBS" + }, + { + "label": "Personal consumption expenditures: Goods (chain-type price index)", + "value": "DGDSRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Durable goods (chain-type price index)", + "value": "DDURRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Services (chain-type price index)", + "value": "DSERRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Nondurable goods (chain-type price index)", + "value": "DNDGRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Services: Household consumption expenditures (chain-type price index)", + "value": "DHCERG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Durable goods: Motor vehicles and parts (chain-type price index)", + "value": "DMOTRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Durable goods: Furnishings and durable household equipment (chain-type price index)", + "value": "DFDHRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Durable goods: Recreational goods and vehicles (chain-type price index)", + "value": "DREQRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Durable goods: Other durable goods (chain-type price index)", + "value": "DODGRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Nondurable goods: Food and beverages purchased for off-premises consumption (chain-type price index)", + "value": "DFXARG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Nondurable goods: Clothing and footwear (chain-type price index)", + "value": "DCLORG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Nondurable goods: Gasoline and other energy goods (chain-type price index)", + "value": "DGOERG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Nondurable goods: Other nondurable goods (chain-type price index)", + "value": "DONGRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Services: Housing and utilities (chain-type price index)", + "value": "DHUTRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Services: Health care (chain-type price index)", + "value": "DHLCRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Transportation services (chain-type price index)", + "value": "DTRSRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Recreation services (chain-type price index)", + "value": "DRCARG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Services: Food services and accommodations (chain-type price index)", + "value": "DFSARG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Financial services and insurance (chain-type price index)", + "value": "DIFSRG3Q086SBEA" + }, + { + "label": "Personal consumption expenditures: Other services (chain-type price index)", + "value": "DOTSRG3Q086SBEA" + }, + { + "label": "Consumer Price Index for All Urban Consumers: All Items (Index 1982-84=100)", + "value": "CPIAUCSL" + }, + { + "label": "Consumer Price Index for All Urban Consumers: All Items Less Food & Energy (Index 1982-84=100)", + "value": "CPILFESL" + }, + { + "label": "Producer Price Index by Commodity for Finished Goods (Index 1982=100)", + "value": "WPSFD49207" + }, + { + "label": "Producer Price Index for All Commodities (Index 1982=100)", + "value": "PPIACO" + }, + { + "label": "Producer Price Index by Commodity for Finished Consumer Goods (Index 1982=100)", + "value": "WPSFD49502" + }, + { + "label": "Producer Price Index by Commodity for Finished Consumer Foods (Index 1982=100)", + "value": "WPSFD4111" + }, + { + "label": "Producer Price Index by Commodity Industrial Commodities (Index 1982=100)", + "value": "PPIIDC" + }, + { + "label": "Producer Price Index by Commodity Intermediate Materials: Supplies & Components (Index 1982=100)", + "value": "WPSID61" + }, + { + "label": "Producer Price Index by Commodity for Fuels and Related Products and Power: Natural Gas (Index 1982=100)", + "value": "WPU0531" + }, + { + "label": "Producer Price Index by Commodity for Fuels and Related Products and Power: Crude Petroleum (Domestic Production) (Index 1982=100)", + "value": "WPU0561" + }, + { + "label": "Real Crude Oil Prices: West Texas Intermediate (WTI) - Cushing, Oklahoma (2017 Dollars per Barrel), deflated by Core PCE", + "value": "OILPRICEx" + }, + { + "label": "Real Average Hourly Earnings of Production and Nonsupervisory Employees: Total Private (2017 Dollars per Hour), deflated by Core PCE", + "value": "AHETPIx" + }, + { + "label": "Real Average Hourly Earnings of Production and Nonsupervisory Employees: Construction (2017 Dollars per Hour), deflated by Core PCE", + "value": "CES2000000008x" + }, + { + "label": "Real Average Hourly Earnings of Production and Nonsupervisory Employees: Manufacturing (2017 Dollars per Hour), deflated by Core PCE", + "value": "CES3000000008x" + }, + { + "label": "Manufacturing Sector: Real Compensation Per Hour (Index 2017=100)", + "value": "COMPRMS" + }, + { + "label": "Nonfarm Business Sector: Real Compensation Per Hour (Index 2017=100)", + "value": "COMPRNFB" + }, + { + "label": "Business Sector: Real Compensation Per Hour (Index 2017=100)", + "value": "RCPHBS" + }, + { + "label": "Manufacturing Sector: Real Output Per Hour of All Persons (Index 2017=100)", + "value": "OPHMFG" + }, + { + "label": "Nonfarm Business Sector: Real Output Per Hour of All Persons (Index 2017=100)", + "value": "OPHNFB" + }, + { + "label": "Business Sector: Real Output Per Hour of All Persons (Index 2017=100)", + "value": "OPHPBS" + }, + { + "label": "Business Sector: Unit Labor Cost (Index 2017=100)", + "value": "ULCBS" + }, + { + "label": "Manufacturing Sector: Unit Labor Cost (Index 2017=100)", + "value": "ULCMFG" + }, + { + "label": "Nonfarm Business Sector: Unit Labor Cost (Index 2017=100)", + "value": "ULCNFB" + }, + { + "label": "Nonfarm Business Sector: Unit Nonlabor Payments (Index 2017=100)", + "value": "UNLPNBS" + }, + { + "label": "Effective Federal Funds Rate (Percent)", + "value": "FEDFUNDS" + }, + { + "label": "3-Month Treasury Bill: Secondary Market Rate (Percent)", + "value": "TB3MS" + }, + { + "label": "6-Month Treasury Bill: Secondary Market Rate (Percent)", + "value": "TB6MS" + }, + { + "label": "1-Year Treasury Constant Maturity Rate (Percent)", + "value": "GS1" + }, + { + "label": "10-Year Treasury Constant Maturity Rate (Percent)", + "value": "GS10" + }, + { + "label": "30-Year Conventional Mortgage Rate\u00a9 (Percent)", + "value": "MORTGAGE30US" + }, + { + "label": "Moody's Seasoned Aaa Corporate Bond Yield\u00a9 (Percent)", + "value": "AAA" + }, + { + "label": "Moody's Seasoned Baa Corporate Bond Yield\u00a9 (Percent)", + "value": "BAA" + }, + { + "label": "Moody's Seasoned Baa Corporate Bond Yield Relative to Yield on 10-Year Treasury Constant Maturity (Percent)", + "value": "BAA10YM" + }, + { + "label": "30-Year Conventional Mortgage Rate Relative to 10-Year Treasury Constant Maturity (Percent)", + "value": "MORTG10YRx" + }, + { + "label": "6-Month Treasury Bill Minus 3-Month Treasury Bill, secondary market (Percent)", + "value": "TB6M3Mx" + }, + { + "label": "1-Year Treasury Constant Maturity Minus 3-Month Treasury Bill, secondary market (Percent)", + "value": "GS1TB3Mx" + }, + { + "label": "10-Year Treasury Constant Maturity Minus 3-Month Treasury Bill, secondary market (Percent)", + "value": "GS10TB3Mx" + }, + { + "label": "3-Month Commercial Paper Minus 3-Month Treasury Bill, secondary market (Percent)", + "value": "CPF3MTB3Mx" + }, + { + "label": "St. Louis Adjusted Monetary Base (Billions of 1982-84 Dollars), deflated by CPI", + "value": "BOGMBASEREALx" + }, + { + "label": "Real M1 Money Stock (Billions of 1982-84 Dollars), deflated by CPI", + "value": "M1REAL" + }, + { + "label": "Real M2 Money Stock (Billions of 1982-84 Dollars), deflated by CPI", + "value": "M2REAL" + }, + { + "label": "Real Commercial and Industrial Loans, All Commercial Banks (Billions of 2017 U.S. Dollars), deflated by Core PCE", + "value": "BUSLOANSx" + }, + { + "label": "Real Consumer Loans at All Commercial Banks (Billions of 2017 U.S. Dollars), deflated by Core PCE", + "value": "CONSUMERx" + }, + { + "label": "Total Real Nonrevolving Credit Owned and Securitized, Outstanding (Billions of Dollars), deflated by Core PCE", + "value": "NONREVSLx" + }, + { + "label": "Real Real Estate Loans, All Commercial Banks (Billions of 2017 U.S. Dollars), deflated by Core PCE", + "value": "REALLNx" + }, + { + "label": "Total Real Revolving Credit Owned and Securitized, Outstanding (Billions of 2017 Dollars), deflated by Core PCE", + "value": "REVOLSLx" + }, + { + "label": "Total Consumer Credit Outstanding, deflated by Core PCE", + "value": "TOTALSLx" + }, + { + "label": "FRB Senior Loans Officer Opions. Net Percentage of Domestic Respondents Reporting Increased Willingness to Make Consumer Installment Loans", + "value": "DRIWCIL" + }, + { + "label": "Real Total Assets of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "value": "TABSHNOx" + }, + { + "label": "Real Total Liabilities of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "value": "TLBSHNOx" + }, + { + "label": "Liabilities of Households and Nonprofit Organizations Relative to Personal Disposable Income (Percent)", + "value": "LIABPIx" + }, + { + "label": "Real Net Worth of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "value": "TNWBSHNOx" + }, + { + "label": "Net Worth of Households and Nonprofit Organizations Relative to Disposable Personal Income (Percent)", + "value": "NWPIx" + }, + { + "label": "Real Assets of Households and Nonprofit Organizations excluding Real Estate Assets (Billions of 2017 Dollars), deflated by Core PCE", + "value": "TARESAx" + }, + { + "label": "Real Real Estate Assets of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "value": "HNOREMQ027Sx" + }, + { + "label": "Real Total Financial Assets of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "value": "TFAABSHNOx" + }, + { + "label": "CBOE Volatility Index: VIX", + "value": "VIXCLSx" + }, + { + "label": "All-Transactions House Price Index for the United States (Index 1980 Q1=100)", + "value": "USSTHPI" + }, + { + "label": "S&P/Case-Shiller 10-City Composite Home Price Index (Index January 2000 = 100)", + "value": "SPCS10RSA" + }, + { + "label": "S&P/Case-Shiller 20-City Composite Home Price Index (Index January 2000 = 100)", + "value": "SPCS20RSA" + }, + { + "label": "Trade Weighted U.S. Dollar Index: Major Currencies (Index March 1973=100)", + "value": "TWEXAFEGSMTHx" + }, + { + "label": "U.S. / Euro Foreign Exchange Rate (U.S. Dollars to One Euro)", + "value": "EXUSEU" + }, + { + "label": "Switzerland / U.S. Foreign Exchange Rate", + "value": "EXSZUSx" + }, + { + "label": "Japan / U.S. Foreign Exchange Rate", + "value": "EXJPUSx" + }, + { + "label": "U.S. / U.K. Foreign Exchange Rate", + "value": "EXUSUKx" + }, + { + "label": "Canada / U.S. Foreign Exchange Rate", + "value": "EXCAUSx" + }, + { + "label": "University of Michigan: Consumer Sentiment (Index 1st Quarter 1966=100)", + "value": "UMCSENTx" + }, + { + "label": "Economic Policy Uncertainty Index for United States", + "value": "USEPUINDXM" + }, + { + "label": "Shares of gross domestic product: Exports of goods and services (Percent)", + "value": "B020RE1Q156NBEA" + }, + { + "label": "Shares of gross domestic product: Imports of goods and services (Percent)", + "value": "B021RE1Q156NBEA" + }, + { + "label": "Federal Debt: Total Public Debt as Percent of GDP (Percent)", + "value": "GFDEGDQ188S" + }, + { + "label": "Real Federal Debt: Total Public Debt (Millions of 2017 Dollars), deflated by PCE", + "value": "GFDEBTNx" + }, + { + "label": "Industrial Production: Manufacturing (SIC) (Index 2017=100)", + "value": "IPMANSICS" + }, + { + "label": "Industrial Production: Residential Utilities (Index 2017=100)", + "value": "IPB51222S" + }, + { + "label": "Industrial Production: Fuels (Index 2017=100)", + "value": "IPFUELS" + }, + { + "label": "Average (Mean) Duration of Unemployment (Weeks)", + "value": "UEMPMEAN" + }, + { + "label": "Average Weekly Hours of Production and Nonsupervisory Employees: Goods-Producing", + "value": "CES0600000007" + }, + { + "label": "Total Reserves of Depository Institutions (Billions of Dollars)", + "value": "TOTRESNS" + }, + { + "label": "Reserves Of Depository Institutions, Nonborrowed (Millions of Dollars)", + "value": "NONBORRES" + }, + { + "label": "5-Year Treasury Constant Maturity Rate", + "value": "GS5" + }, + { + "label": "3-Month Treasury Constant Maturity Minus Federal Funds Rate", + "value": "TB3SMFFM" + }, + { + "label": "5-Year Treasury Constant Maturity Minus Federal Funds Rate", + "value": "T5YFFM" + }, + { + "label": "Moody's Seasoned Aaa Corporate Bond Minus Federal Funds Rate", + "value": "AAAFFM" + }, + { + "label": "Producer Price Index: Crude Materials for Further Processing (Index 1982=100)", + "value": "WPSID62" + }, + { + "label": "Producer Price Index: Commodities: Metals and metal products: Primary nonferrous metals (Index 1982=100)", + "value": "PPICMM" + }, + { + "label": "Consumer Price Index for All Urban Consumers: Apparel (Index 1982-84=100)", + "value": "CPIAPPSL" + }, + { + "label": "Consumer Price Index for All Urban Consumers: Transportation (Index 1982-84=100)", + "value": "CPITRNSL" + }, + { + "label": "Consumer Price Index for All Urban Consumers: Medical Care (Index 1982-84=100)", + "value": "CPIMEDSL" + }, + { + "label": "Consumer Price Index for All Urban Consumers: Commodities (Index 1982-84=100)", + "value": "CUSR0000SAC" + }, + { + "label": "Consumer Price Index for All Urban Consumers: Durables (Index 1982-84=100)", + "value": "CUSR0000SAD" + }, + { + "label": "Consumer Price Index for All Urban Consumers: Services (Index 1982-84=100)", + "value": "CUSR0000SAS" + }, + { + "label": "Consumer Price Index for All Urban Consumers: All Items Less Food (Index 1982-84=100)", + "value": "CPIULFSL" + }, + { + "label": "Consumer Price Index for All Urban Consumers: All items less shelter (Index 1982-84=100)", + "value": "CUSR0000SA0L2" + }, + { + "label": "Consumer Price Index for All Urban Consumers: All items less medical care (Index 1982-84=100)", + "value": "CUSR0000SA0L5" + }, + { + "label": "Average Hourly Earnings of Production and Nonsupervisory Employees: Goods-Producing (Dollars per Hour)", + "value": "CES0600000008" + }, + { + "label": "Consumer Motor Vehicle Loans Outstanding Owned by Finance Companies (Millions of Dollars)", + "value": "DTCOLNVHFNM" + }, + { + "label": "Total Consumer Loans and Leases Outstanding Owned and Securitized by Finance Companies (Millions of Dollars)", + "value": "DTCTHFNM" + }, + { + "label": "Securities in Bank Credit at All Commercial Banks (Billions of Dollars)", + "value": "INVEST" + }, + { + "label": "Ratio of Help Wanted/No. Unemployed", + "value": "HWIURATIOx" + }, + { + "label": "Initial Claims", + "value": "CLAIMSx" + }, + { + "label": "Total Business Inventories (Millions of Dollars)", + "value": "BUSINVx" + }, + { + "label": "Total Business: Inventories to Sales Ratio", + "value": "ISRATIOx" + }, + { + "label": "Nonrevolving consumer credit to Personal Income", + "value": "CONSPIx" + }, + { + "label": "3-Month AA Financial Commercial Paper Rate", + "value": "CP3M" + }, + { + "label": "3-Month Commercial Paper Minus Federal Funds Rate", + "value": "COMPAPFF" + }, + { + "label": "New Private Housing Units Authorized by Building Permits in the Northeast Census Region (Thousands, SAAR)", + "value": "PERMITNE" + }, + { + "label": "New Private Housing Units Authorized by Building Permits in the Midwest Census Region (Thousands, SAAR)", + "value": "PERMITMW" + }, + { + "label": "New Private Housing Units Authorized by Building Permits in the South Census Region (Thousands, SAAR)", + "value": "PERMITS" + }, + { + "label": "New Private Housing Units Authorized by Building Permits in the West Census Region (Thousands, SAAR)", + "value": "PERMITW" + }, + { + "label": "Nikkei Stock Average", + "value": "NIKKEI225" + }, + { + "label": "NASDAQ Composite (Index Feb 5, 1971=100)", + "value": "NASDAQCOM" + }, + { + "label": "CPI for All Urban Consumers: Owners' equivalent rent of residences (Index Dec 1982=100)", + "value": "CUSR0000SEHC" + }, + { + "label": "Real Nonfinancial Corporate Business Sector Liabilities (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "value": "TLBSNNCBx" + }, + { + "label": "Nonfinancial Corporate Business Sector Liabilities to Disposable Business Income (Percent)", + "value": "TLBSNNCBBDIx" + }, + { + "label": "Real Nonfinancial Corporate Business Sector Assets (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "value": "TTAABSNNCBx" + }, + { + "label": "Real Nonfinancial Corporate Business Sector Net Worth (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "value": "TNWMVBSNNCBx" + }, + { + "label": "Nonfinancial Corporate Business Sector Net Worth to Disposable Business Income (Percent)", + "value": "TNWMVBSNNCBBDIx" + }, + { + "label": "Real Nonfinancial Noncorporate Business Sector Liabilities (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "value": "TLBSNNBx" + }, + { + "label": "Nonfinancial Noncorporate Business Sector Liabilities to Disposable Business Income (Percent)", + "value": "TLBSNNBBDIx" + }, + { + "label": "Real Nonfinancial Noncorporate Business Sector Assets (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "value": "TABSNNBx" + }, + { + "label": "Real Nonfinancial Noncorporate Business Sector Net Worth (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "value": "TNWBSNNBx" + }, + { + "label": "Nonfinancial Noncorporate Business Sector Net Worth to Disposable Business Income (Percent)", + "value": "TNWBSNNBBDIx" + }, + { + "label": "Real Disposable Business Income, Billions of 2017 Dollars (Corporate cash flow with IVA minus taxes on corporate income, deflated by Implicit Price Deflator for Business Sector IPDBS)", + "value": "CNCFx" + }, + { + "label": "S&P's Common Stock Price Index: Composite", + "value": "S&P 500" + }, + { + "label": "S&P's Composite Common Stock: Dividend Yield", + "value": "S&P div yield" + }, + { + "label": "S&P's Composite Common Stock: Price-Earnings Ratio", + "value": "S&P PE ratio" + } + ], + "multiSelect": true + } + } + }, + { + "name": "transform", + "type": "bool | None", + "description": "Apply each series' recommended stationarity transformation (its transform code) instead of returning raw levels.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveStLouisFredQd", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveStLouisFredQd", + "openapi_extra": { + "widget_config": { + "name": "FRED-QD Quarterly Macro Panel, St. Louis Fed", + "description": "The McCracken-Ng quarterly database of 200+ U.S. macroeconomic series as a wide panel, one column per series.", + "subCategory": "Macro Data Panels", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "GDPC1", + "headerName": "Real Gross Domestic Product, 3 Decimal (Billions of Chained 2017 Dollars)", + "headerTooltip": "GDPC1", + "cellDataType": "number" + }, + { + "field": "PCECC96", + "headerName": "Real Personal Consumption Expenditures (Billions of Chained 2017 Dollars)", + "headerTooltip": "PCECC96", + "cellDataType": "number" + }, + { + "field": "PCDGx", + "headerName": "Real personal consumption expenditures: Durable goods (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "PCDGx", + "cellDataType": "number" + }, + { + "field": "PCESVx", + "headerName": "Real Personal Consumption Expenditures: Services (Billions of 2017 Dollars), deflated using its own price index", + "headerTooltip": "PCESVx", + "cellDataType": "number" + }, + { + "field": "PCNDx", + "headerName": "Real Personal Consumption Expenditures: Nondurable Goods (Billions of 2017 Dollars), deflated using its own price index", + "headerTooltip": "PCNDx", + "cellDataType": "number" + }, + { + "field": "GPDIC1", + "headerName": "Real Gross Private Domestic Investment, 3 decimal (Billions of Chained 2017 Dollars)", + "headerTooltip": "GPDIC1", + "cellDataType": "number" + }, + { + "field": "FPIx", + "headerName": "Real private fixed investment (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "FPIx", + "cellDataType": "number" + }, + { + "field": "Y033RC1Q027SBEAx", + "headerName": "Real Gross Private Domestic Investment: Fixed Investment: Nonresidential: Equipment (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "Y033RC1Q027SBEAx", + "cellDataType": "number" + }, + { + "field": "PNFIx", + "headerName": "Real private fixed investment: Nonresidential (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "PNFIx", + "cellDataType": "number" + }, + { + "field": "PRFIx", + "headerName": "Real private fixed investment: Residential (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "PRFIx", + "cellDataType": "number" + }, + { + "field": "A014RE1Q156NBEA", + "headerName": "Shares of gross domestic product: Gross private domestic investment: Change in private inventories (Percent)", + "headerTooltip": "A014RE1Q156NBEA", + "cellDataType": "number" + }, + { + "field": "GCEC1", + "headerName": "Real Government Consumption Expenditures & Gross Investment (Billions of Chained 2017 Dollars)", + "headerTooltip": "GCEC1", + "cellDataType": "number" + }, + { + "field": "A823RL1Q225SBEA", + "headerName": "Real Government Consumption Expenditures and Gross Investment: Federal (Percent Change from Preceding Period)", + "headerTooltip": "A823RL1Q225SBEA", + "cellDataType": "number" + }, + { + "field": "FGRECPTx", + "headerName": "Real Federal Government Current Receipts (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "FGRECPTx", + "cellDataType": "number" + }, + { + "field": "SLCEx", + "headerName": "Real government state and local consumption expenditures (Billions of Chained 2017 Dollars), deflated using its own price index", + "headerTooltip": "SLCEx", + "cellDataType": "number" + }, + { + "field": "EXPGSC1", + "headerName": "Real Exports of Goods & Services, 3 Decimal (Billions of Chained 2017 Dollars)", + "headerTooltip": "EXPGSC1", + "cellDataType": "number" + }, + { + "field": "IMPGSC1", + "headerName": "Real Imports of Goods & Services, 3 Decimal (Billions of Chained 2017 Dollars)", + "headerTooltip": "IMPGSC1", + "cellDataType": "number" + }, + { + "field": "DPIC96", + "headerName": "Real Disposable Personal Income (Billions of Chained 2017 Dollars)", + "headerTooltip": "DPIC96", + "cellDataType": "number" + }, + { + "field": "OUTNFB", + "headerName": "Nonfarm Business Sector: Real Output (Index 2017=100)", + "headerTooltip": "OUTNFB", + "cellDataType": "number" + }, + { + "field": "OUTBS", + "headerName": "Business Sector: Real Output (Index 2017=100)", + "headerTooltip": "OUTBS", + "cellDataType": "number" + }, + { + "field": "OUTMS", + "headerName": "Manufacturing Sector: Real Output (Index 2017=100)", + "headerTooltip": "OUTMS", + "cellDataType": "number" + }, + { + "field": "INDPRO", + "headerName": "Industrial Production Index (Index 2017=100)", + "headerTooltip": "INDPRO", + "cellDataType": "number" + }, + { + "field": "IPFINAL", + "headerName": "Industrial Production: Final Products (Market Group) (Index 2017=100)", + "headerTooltip": "IPFINAL", + "cellDataType": "number" + }, + { + "field": "IPCONGD", + "headerName": "Industrial Production: Consumer Goods (Index 2017=100)", + "headerTooltip": "IPCONGD", + "cellDataType": "number" + }, + { + "field": "IPMAT", + "headerName": "Industrial Production: Materials (Index 2017=100)", + "headerTooltip": "IPMAT", + "cellDataType": "number" + }, + { + "field": "IPDMAT", + "headerName": "Industrial Production: Durable Materials (Index 2017=100)", + "headerTooltip": "IPDMAT", + "cellDataType": "number" + }, + { + "field": "IPNMAT", + "headerName": "Industrial Production: Nondurable Materials (Index 2017=100)", + "headerTooltip": "IPNMAT", + "cellDataType": "number" + }, + { + "field": "IPDCONGD", + "headerName": "Industrial Production: Durable Consumer Goods (Index 2017=100)", + "headerTooltip": "IPDCONGD", + "cellDataType": "number" + }, + { + "field": "IPB51110SQ", + "headerName": "Industrial Production: Durable Goods: Automotive products (Index 2017=100)", + "headerTooltip": "IPB51110SQ", + "cellDataType": "number" + }, + { + "field": "IPNCONGD", + "headerName": "Industrial Production: Nondurable Consumer Goods (Index 2017=100)", + "headerTooltip": "IPNCONGD", + "cellDataType": "number" + }, + { + "field": "IPBUSEQ", + "headerName": "Industrial Production: Business Equipment (Index 2017=100)", + "headerTooltip": "IPBUSEQ", + "cellDataType": "number" + }, + { + "field": "IPB51220SQ", + "headerName": "Industrial Production: Consumer energy products (Index 2017=100)", + "headerTooltip": "IPB51220SQ", + "cellDataType": "number" + }, + { + "field": "TCU", + "headerName": "Capacity Utilization: Total Industry (Percent of Capacity)", + "headerTooltip": "TCU", + "cellDataType": "number" + }, + { + "field": "CUMFNS", + "headerName": "Capacity Utilization: Manufacturing (SIC) (Percent of Capacity)", + "headerTooltip": "CUMFNS", + "cellDataType": "number" + }, + { + "field": "PAYEMS", + "headerName": "All Employees: Total nonfarm (Thousands of Persons)", + "headerTooltip": "PAYEMS", + "cellDataType": "number" + }, + { + "field": "USPRIV", + "headerName": "All Employees: Total Private Industries (Thousands of Persons)", + "headerTooltip": "USPRIV", + "cellDataType": "number" + }, + { + "field": "MANEMP", + "headerName": "All Employees: Manufacturing (Thousands of Persons)", + "headerTooltip": "MANEMP", + "cellDataType": "number" + }, + { + "field": "SRVPRD", + "headerName": "All Employees: Service-Providing Industries (Thousands of Persons)", + "headerTooltip": "SRVPRD", + "cellDataType": "number" + }, + { + "field": "USGOOD", + "headerName": "All Employees: Goods-Producing Industries (Thousands of Persons)", + "headerTooltip": "USGOOD", + "cellDataType": "number" + }, + { + "field": "DMANEMP", + "headerName": "All Employees: Durable goods (Thousands of Persons)", + "headerTooltip": "DMANEMP", + "cellDataType": "number" + }, + { + "field": "NDMANEMP", + "headerName": "All Employees: Nondurable goods (Thousands of Persons)", + "headerTooltip": "NDMANEMP", + "cellDataType": "number" + }, + { + "field": "USCONS", + "headerName": "All Employees: Construction (Thousands of Persons)", + "headerTooltip": "USCONS", + "cellDataType": "number" + }, + { + "field": "USEHS", + "headerName": "All Employees: Education & Health Services (Thousands of Persons)", + "headerTooltip": "USEHS", + "cellDataType": "number" + }, + { + "field": "USFIRE", + "headerName": "All Employees: Financial Activities (Thousands of Persons)", + "headerTooltip": "USFIRE", + "cellDataType": "number" + }, + { + "field": "USINFO", + "headerName": "All Employees: Information Services (Thousands of Persons)", + "headerTooltip": "USINFO", + "cellDataType": "number" + }, + { + "field": "USPBS", + "headerName": "All Employees: Professional & Business Services (Thousands of Persons)", + "headerTooltip": "USPBS", + "cellDataType": "number" + }, + { + "field": "USLAH", + "headerName": "All Employees: Leisure & Hospitality (Thousands of Persons)", + "headerTooltip": "USLAH", + "cellDataType": "number" + }, + { + "field": "USSERV", + "headerName": "All Employees: Other Services (Thousands of Persons)", + "headerTooltip": "USSERV", + "cellDataType": "number" + }, + { + "field": "USMINE", + "headerName": "All Employees: Mining and logging (Thousands of Persons)", + "headerTooltip": "USMINE", + "cellDataType": "number" + }, + { + "field": "USTPU", + "headerName": "All Employees: Trade, Transportation & Utilities (Thousands of Persons)", + "headerTooltip": "USTPU", + "cellDataType": "number" + }, + { + "field": "USGOVT", + "headerName": "All Employees: Government (Thousands of Persons)", + "headerTooltip": "USGOVT", + "cellDataType": "number" + }, + { + "field": "USTRADE", + "headerName": "All Employees: Retail Trade (Thousands of Persons)", + "headerTooltip": "USTRADE", + "cellDataType": "number" + }, + { + "field": "USWTRADE", + "headerName": "All Employees: Wholesale Trade (Thousands of Persons)", + "headerTooltip": "USWTRADE", + "cellDataType": "number" + }, + { + "field": "CES9091000001", + "headerName": "All Employees: Government: Federal (Thousands of Persons)", + "headerTooltip": "CES9091000001", + "cellDataType": "number" + }, + { + "field": "CES9092000001", + "headerName": "All Employees: Government: State Government (Thousands of Persons)", + "headerTooltip": "CES9092000001", + "cellDataType": "number" + }, + { + "field": "CES9093000001", + "headerName": "All Employees: Government: Local Government (Thousands of Persons)", + "headerTooltip": "CES9093000001", + "cellDataType": "number" + }, + { + "field": "CE16OV", + "headerName": "Civilian Employment (Thousands of Persons)", + "headerTooltip": "CE16OV", + "cellDataType": "number" + }, + { + "field": "CIVPART", + "headerName": "Civilian Labor Force Participation Rate (Percent)", + "headerTooltip": "CIVPART", + "cellDataType": "number" + }, + { + "field": "UNRATE", + "headerName": "Civilian Unemployment Rate (Percent)", + "headerTooltip": "UNRATE", + "cellDataType": "number" + }, + { + "field": "UNRATESTx", + "headerName": "Unemployment Rate less than 27 weeks (Percent)", + "headerTooltip": "UNRATESTx", + "cellDataType": "number" + }, + { + "field": "UNRATELTx", + "headerName": "Unemployment Rate for more than 27 weeks (Percent)", + "headerTooltip": "UNRATELTx", + "cellDataType": "number" + }, + { + "field": "LNS14000012", + "headerName": "Unemployment Rate - 16 to 19 years (Percent)", + "headerTooltip": "LNS14000012", + "cellDataType": "number" + }, + { + "field": "LNS14000025", + "headerName": "Unemployment Rate - 20 years and over, Men (Percent)", + "headerTooltip": "LNS14000025", + "cellDataType": "number" + }, + { + "field": "LNS14000026", + "headerName": "Unemployment Rate - 20 years and over, Women (Percent)", + "headerTooltip": "LNS14000026", + "cellDataType": "number" + }, + { + "field": "UEMPLT5", + "headerName": "Number of Civilians Unemployed - Less Than 5 Weeks (Thousands of Persons)", + "headerTooltip": "UEMPLT5", + "cellDataType": "number" + }, + { + "field": "UEMP5TO14", + "headerName": "Number of Civilians Unemployed for 5 to 14 Weeks (Thousands of Persons)", + "headerTooltip": "UEMP5TO14", + "cellDataType": "number" + }, + { + "field": "UEMP15T26", + "headerName": "Number of Civilians Unemployed for 15 to 26 Weeks (Thousands of Persons)", + "headerTooltip": "UEMP15T26", + "cellDataType": "number" + }, + { + "field": "UEMP27OV", + "headerName": "Number of Civilians Unemployed for 27 Weeks and Over (Thousands of Persons)", + "headerTooltip": "UEMP27OV", + "cellDataType": "number" + }, + { + "field": "LNS13023621", + "headerName": "Unemployment Level - Job Losers (Thousands of Persons)", + "headerTooltip": "LNS13023621", + "cellDataType": "number" + }, + { + "field": "LNS13023557", + "headerName": "Unemployment Level - Reentrants to Labor Force (Thousands of Persons)", + "headerTooltip": "LNS13023557", + "cellDataType": "number" + }, + { + "field": "LNS13023705", + "headerName": "Unemployment Level - Job Leavers (Thousands of Persons)", + "headerTooltip": "LNS13023705", + "cellDataType": "number" + }, + { + "field": "LNS13023569", + "headerName": "Unemployment Level - New Entrants (Thousands of Persons)", + "headerTooltip": "LNS13023569", + "cellDataType": "number" + }, + { + "field": "LNS12032194", + "headerName": "Employment Level - Part-Time for Economic Reasons, All Industries (Thousands of Persons)", + "headerTooltip": "LNS12032194", + "cellDataType": "number" + }, + { + "field": "HOABS", + "headerName": "Business Sector: Hours of All Persons (Index 2017=100)", + "headerTooltip": "HOABS", + "cellDataType": "number" + }, + { + "field": "HOAMS", + "headerName": "Manufacturing Sector: Hours of All Persons (Index 2017=100)", + "headerTooltip": "HOAMS", + "cellDataType": "number" + }, + { + "field": "HOANBS", + "headerName": "Nonfarm Business Sector: Hours of All Persons (Index 2017=100)", + "headerTooltip": "HOANBS", + "cellDataType": "number" + }, + { + "field": "AWHMAN", + "headerName": "Average Weekly Hours of Production and Nonsupervisory Employees: Manufacturing (Hours)", + "headerTooltip": "AWHMAN", + "cellDataType": "number" + }, + { + "field": "AWHNONAG", + "headerName": "Average Weekly Hours Of Production And Nonsupervisory Employees: Total private (Hours)", + "headerTooltip": "AWHNONAG", + "cellDataType": "number" + }, + { + "field": "AWOTMAN", + "headerName": "Average Weekly Overtime Hours of Production and Nonsupervisory Employees: Manufacturing (Hours)", + "headerTooltip": "AWOTMAN", + "cellDataType": "number" + }, + { + "field": "HWIx", + "headerName": "Help-Wanted Index", + "headerTooltip": "HWIx", + "cellDataType": "number" + }, + { + "field": "HOUST", + "headerName": "Housing Starts: Total: New Privately Owned Housing Units Started (Thousands of Units)", + "headerTooltip": "HOUST", + "cellDataType": "number" + }, + { + "field": "HOUST5F", + "headerName": "Privately Owned Housing Starts: 5-Unit Structures or More (Thousands of Units)", + "headerTooltip": "HOUST5F", + "cellDataType": "number" + }, + { + "field": "PERMIT", + "headerName": "New Private Housing Units Authorized by Building Permits (Thousands of Units)", + "headerTooltip": "PERMIT", + "cellDataType": "number" + }, + { + "field": "HOUSTMW", + "headerName": "Housing Starts in Midwest Census Region (Thousands of Units)", + "headerTooltip": "HOUSTMW", + "cellDataType": "number" + }, + { + "field": "HOUSTNE", + "headerName": "Housing Starts in Northeast Census Region (Thousands of Units)", + "headerTooltip": "HOUSTNE", + "cellDataType": "number" + }, + { + "field": "HOUSTS", + "headerName": "Housing Starts in South Census Region (Thousands of Units)", + "headerTooltip": "HOUSTS", + "cellDataType": "number" + }, + { + "field": "HOUSTW", + "headerName": "Housing Starts in West Census Region (Thousands of Units)", + "headerTooltip": "HOUSTW", + "cellDataType": "number" + }, + { + "field": "CMRMTSPLx", + "headerName": "Real Manufacturing and Trade Industries Sales (Millions of Chained 2017 Dollars)", + "headerTooltip": "CMRMTSPLx", + "cellDataType": "number" + }, + { + "field": "RSAFSx", + "headerName": "Real Retail and Food Services Sales (Millions of Chained 2017 Dollars), deflated by Core PCE", + "headerTooltip": "RSAFSx", + "cellDataType": "number" + }, + { + "field": "AMDMNOx", + "headerName": "Real Manufacturers' New Orders: Durable Goods (Millions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "AMDMNOx", + "cellDataType": "number" + }, + { + "field": "ACOGNOx", + "headerName": "Real Value of Manufacturers' New Orders for Consumer Goods Industries (Million of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "ACOGNOx", + "cellDataType": "number" + }, + { + "field": "AMDMUOx", + "headerName": "Real Value of Manufacturers' Unfilled Orders for Durable Goods Industries (Million of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "AMDMUOx", + "cellDataType": "number" + }, + { + "field": "ANDENOx", + "headerName": "Real Value of Manufacturers' New Orders for Capital Goods: Nondefense Capital Goods Industries (Million of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "ANDENOx", + "cellDataType": "number" + }, + { + "field": "INVCQRMTSPL", + "headerName": "Real Manufacturing and Trade Inventories (Millions of 2017 Dollars)", + "headerTooltip": "INVCQRMTSPL", + "cellDataType": "number" + }, + { + "field": "PCECTPI", + "headerName": "Personal Consumption Expenditures: Chain-type Price Index (Index 2017=100)", + "headerTooltip": "PCECTPI", + "cellDataType": "number" + }, + { + "field": "PCEPILFE", + "headerName": "Personal Consumption Expenditures Excluding Food and Energy (Chain-Type Price Index) (Index 2017=100)", + "headerTooltip": "PCEPILFE", + "cellDataType": "number" + }, + { + "field": "GDPCTPI", + "headerName": "Gross Domestic Product: Chain-type Price Index (Index 2017=100)", + "headerTooltip": "GDPCTPI", + "cellDataType": "number" + }, + { + "field": "GPDICTPI", + "headerName": "Gross Private Domestic Investment: Chain-type Price Index (Index 2017=100)", + "headerTooltip": "GPDICTPI", + "cellDataType": "number" + }, + { + "field": "IPDBS", + "headerName": "Business Sector: Implicit Price Deflator (Index 2017=100)", + "headerTooltip": "IPDBS", + "cellDataType": "number" + }, + { + "field": "DGDSRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Goods (chain-type price index)", + "headerTooltip": "DGDSRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DDURRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Durable goods (chain-type price index)", + "headerTooltip": "DDURRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DSERRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Services (chain-type price index)", + "headerTooltip": "DSERRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DNDGRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Nondurable goods (chain-type price index)", + "headerTooltip": "DNDGRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DHCERG3Q086SBEA", + "headerName": "Personal consumption expenditures: Services: Household consumption expenditures (chain-type price index)", + "headerTooltip": "DHCERG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DMOTRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Durable goods: Motor vehicles and parts (chain-type price index)", + "headerTooltip": "DMOTRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DFDHRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Durable goods: Furnishings and durable household equipment (chain-type price index)", + "headerTooltip": "DFDHRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DREQRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Durable goods: Recreational goods and vehicles (chain-type price index)", + "headerTooltip": "DREQRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DODGRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Durable goods: Other durable goods (chain-type price index)", + "headerTooltip": "DODGRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DFXARG3Q086SBEA", + "headerName": "Personal consumption expenditures: Nondurable goods: Food and beverages purchased for off-premises consumption (chain-type price index)", + "headerTooltip": "DFXARG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DCLORG3Q086SBEA", + "headerName": "Personal consumption expenditures: Nondurable goods: Clothing and footwear (chain-type price index)", + "headerTooltip": "DCLORG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DGOERG3Q086SBEA", + "headerName": "Personal consumption expenditures: Nondurable goods: Gasoline and other energy goods (chain-type price index)", + "headerTooltip": "DGOERG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DONGRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Nondurable goods: Other nondurable goods (chain-type price index)", + "headerTooltip": "DONGRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DHUTRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Services: Housing and utilities (chain-type price index)", + "headerTooltip": "DHUTRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DHLCRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Services: Health care (chain-type price index)", + "headerTooltip": "DHLCRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DTRSRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Transportation services (chain-type price index)", + "headerTooltip": "DTRSRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DRCARG3Q086SBEA", + "headerName": "Personal consumption expenditures: Recreation services (chain-type price index)", + "headerTooltip": "DRCARG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DFSARG3Q086SBEA", + "headerName": "Personal consumption expenditures: Services: Food services and accommodations (chain-type price index)", + "headerTooltip": "DFSARG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DIFSRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Financial services and insurance (chain-type price index)", + "headerTooltip": "DIFSRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "DOTSRG3Q086SBEA", + "headerName": "Personal consumption expenditures: Other services (chain-type price index)", + "headerTooltip": "DOTSRG3Q086SBEA", + "cellDataType": "number" + }, + { + "field": "CPIAUCSL", + "headerName": "Consumer Price Index for All Urban Consumers: All Items (Index 1982-84=100)", + "headerTooltip": "CPIAUCSL", + "cellDataType": "number" + }, + { + "field": "CPILFESL", + "headerName": "Consumer Price Index for All Urban Consumers: All Items Less Food & Energy (Index 1982-84=100)", + "headerTooltip": "CPILFESL", + "cellDataType": "number" + }, + { + "field": "WPSFD49207", + "headerName": "Producer Price Index by Commodity for Finished Goods (Index 1982=100)", + "headerTooltip": "WPSFD49207", + "cellDataType": "number" + }, + { + "field": "PPIACO", + "headerName": "Producer Price Index for All Commodities (Index 1982=100)", + "headerTooltip": "PPIACO", + "cellDataType": "number" + }, + { + "field": "WPSFD49502", + "headerName": "Producer Price Index by Commodity for Finished Consumer Goods (Index 1982=100)", + "headerTooltip": "WPSFD49502", + "cellDataType": "number" + }, + { + "field": "WPSFD4111", + "headerName": "Producer Price Index by Commodity for Finished Consumer Foods (Index 1982=100)", + "headerTooltip": "WPSFD4111", + "cellDataType": "number" + }, + { + "field": "PPIIDC", + "headerName": "Producer Price Index by Commodity Industrial Commodities (Index 1982=100)", + "headerTooltip": "PPIIDC", + "cellDataType": "number" + }, + { + "field": "WPSID61", + "headerName": "Producer Price Index by Commodity Intermediate Materials: Supplies & Components (Index 1982=100)", + "headerTooltip": "WPSID61", + "cellDataType": "number" + }, + { + "field": "WPU0531", + "headerName": "Producer Price Index by Commodity for Fuels and Related Products and Power: Natural Gas (Index 1982=100)", + "headerTooltip": "WPU0531", + "cellDataType": "number" + }, + { + "field": "WPU0561", + "headerName": "Producer Price Index by Commodity for Fuels and Related Products and Power: Crude Petroleum (Domestic Production) (Index 1982=100)", + "headerTooltip": "WPU0561", + "cellDataType": "number" + }, + { + "field": "OILPRICEx", + "headerName": "Real Crude Oil Prices: West Texas Intermediate (WTI) - Cushing, Oklahoma (2017 Dollars per Barrel), deflated by Core PCE", + "headerTooltip": "OILPRICEx", + "cellDataType": "number" + }, + { + "field": "AHETPIx", + "headerName": "Real Average Hourly Earnings of Production and Nonsupervisory Employees: Total Private (2017 Dollars per Hour), deflated by Core PCE", + "headerTooltip": "AHETPIx", + "cellDataType": "number" + }, + { + "field": "CES2000000008x", + "headerName": "Real Average Hourly Earnings of Production and Nonsupervisory Employees: Construction (2017 Dollars per Hour), deflated by Core PCE", + "headerTooltip": "CES2000000008x", + "cellDataType": "number" + }, + { + "field": "CES3000000008x", + "headerName": "Real Average Hourly Earnings of Production and Nonsupervisory Employees: Manufacturing (2017 Dollars per Hour), deflated by Core PCE", + "headerTooltip": "CES3000000008x", + "cellDataType": "number" + }, + { + "field": "COMPRMS", + "headerName": "Manufacturing Sector: Real Compensation Per Hour (Index 2017=100)", + "headerTooltip": "COMPRMS", + "cellDataType": "number" + }, + { + "field": "COMPRNFB", + "headerName": "Nonfarm Business Sector: Real Compensation Per Hour (Index 2017=100)", + "headerTooltip": "COMPRNFB", + "cellDataType": "number" + }, + { + "field": "RCPHBS", + "headerName": "Business Sector: Real Compensation Per Hour (Index 2017=100)", + "headerTooltip": "RCPHBS", + "cellDataType": "number" + }, + { + "field": "OPHMFG", + "headerName": "Manufacturing Sector: Real Output Per Hour of All Persons (Index 2017=100)", + "headerTooltip": "OPHMFG", + "cellDataType": "number" + }, + { + "field": "OPHNFB", + "headerName": "Nonfarm Business Sector: Real Output Per Hour of All Persons (Index 2017=100)", + "headerTooltip": "OPHNFB", + "cellDataType": "number" + }, + { + "field": "OPHPBS", + "headerName": "Business Sector: Real Output Per Hour of All Persons (Index 2017=100)", + "headerTooltip": "OPHPBS", + "cellDataType": "number" + }, + { + "field": "ULCBS", + "headerName": "Business Sector: Unit Labor Cost (Index 2017=100)", + "headerTooltip": "ULCBS", + "cellDataType": "number" + }, + { + "field": "ULCMFG", + "headerName": "Manufacturing Sector: Unit Labor Cost (Index 2017=100)", + "headerTooltip": "ULCMFG", + "cellDataType": "number" + }, + { + "field": "ULCNFB", + "headerName": "Nonfarm Business Sector: Unit Labor Cost (Index 2017=100)", + "headerTooltip": "ULCNFB", + "cellDataType": "number" + }, + { + "field": "UNLPNBS", + "headerName": "Nonfarm Business Sector: Unit Nonlabor Payments (Index 2017=100)", + "headerTooltip": "UNLPNBS", + "cellDataType": "number" + }, + { + "field": "FEDFUNDS", + "headerName": "Effective Federal Funds Rate (Percent)", + "headerTooltip": "FEDFUNDS", + "cellDataType": "number" + }, + { + "field": "TB3MS", + "headerName": "3-Month Treasury Bill: Secondary Market Rate (Percent)", + "headerTooltip": "TB3MS", + "cellDataType": "number" + }, + { + "field": "TB6MS", + "headerName": "6-Month Treasury Bill: Secondary Market Rate (Percent)", + "headerTooltip": "TB6MS", + "cellDataType": "number" + }, + { + "field": "GS1", + "headerName": "1-Year Treasury Constant Maturity Rate (Percent)", + "headerTooltip": "GS1", + "cellDataType": "number" + }, + { + "field": "GS10", + "headerName": "10-Year Treasury Constant Maturity Rate (Percent)", + "headerTooltip": "GS10", + "cellDataType": "number" + }, + { + "field": "MORTGAGE30US", + "headerName": "30-Year Conventional Mortgage Rate\u00a9 (Percent)", + "headerTooltip": "MORTGAGE30US", + "cellDataType": "number" + }, + { + "field": "AAA", + "headerName": "Moody's Seasoned Aaa Corporate Bond Yield\u00a9 (Percent)", + "headerTooltip": "AAA", + "cellDataType": "number" + }, + { + "field": "BAA", + "headerName": "Moody's Seasoned Baa Corporate Bond Yield\u00a9 (Percent)", + "headerTooltip": "BAA", + "cellDataType": "number" + }, + { + "field": "BAA10YM", + "headerName": "Moody's Seasoned Baa Corporate Bond Yield Relative to Yield on 10-Year Treasury Constant Maturity (Percent)", + "headerTooltip": "BAA10YM", + "cellDataType": "number" + }, + { + "field": "MORTG10YRx", + "headerName": "30-Year Conventional Mortgage Rate Relative to 10-Year Treasury Constant Maturity (Percent)", + "headerTooltip": "MORTG10YRx", + "cellDataType": "number" + }, + { + "field": "TB6M3Mx", + "headerName": "6-Month Treasury Bill Minus 3-Month Treasury Bill, secondary market (Percent)", + "headerTooltip": "TB6M3Mx", + "cellDataType": "number" + }, + { + "field": "GS1TB3Mx", + "headerName": "1-Year Treasury Constant Maturity Minus 3-Month Treasury Bill, secondary market (Percent)", + "headerTooltip": "GS1TB3Mx", + "cellDataType": "number" + }, + { + "field": "GS10TB3Mx", + "headerName": "10-Year Treasury Constant Maturity Minus 3-Month Treasury Bill, secondary market (Percent)", + "headerTooltip": "GS10TB3Mx", + "cellDataType": "number" + }, + { + "field": "CPF3MTB3Mx", + "headerName": "3-Month Commercial Paper Minus 3-Month Treasury Bill, secondary market (Percent)", + "headerTooltip": "CPF3MTB3Mx", + "cellDataType": "number" + }, + { + "field": "BOGMBASEREALx", + "headerName": "St. Louis Adjusted Monetary Base (Billions of 1982-84 Dollars), deflated by CPI", + "headerTooltip": "BOGMBASEREALx", + "cellDataType": "number" + }, + { + "field": "M1REAL", + "headerName": "Real M1 Money Stock (Billions of 1982-84 Dollars), deflated by CPI", + "headerTooltip": "M1REAL", + "cellDataType": "number" + }, + { + "field": "M2REAL", + "headerName": "Real M2 Money Stock (Billions of 1982-84 Dollars), deflated by CPI", + "headerTooltip": "M2REAL", + "cellDataType": "number" + }, + { + "field": "BUSLOANSx", + "headerName": "Real Commercial and Industrial Loans, All Commercial Banks (Billions of 2017 U.S. Dollars), deflated by Core PCE", + "headerTooltip": "BUSLOANSx", + "cellDataType": "number" + }, + { + "field": "CONSUMERx", + "headerName": "Real Consumer Loans at All Commercial Banks (Billions of 2017 U.S. Dollars), deflated by Core PCE", + "headerTooltip": "CONSUMERx", + "cellDataType": "number" + }, + { + "field": "NONREVSLx", + "headerName": "Total Real Nonrevolving Credit Owned and Securitized, Outstanding (Billions of Dollars), deflated by Core PCE", + "headerTooltip": "NONREVSLx", + "cellDataType": "number" + }, + { + "field": "REALLNx", + "headerName": "Real Real Estate Loans, All Commercial Banks (Billions of 2017 U.S. Dollars), deflated by Core PCE", + "headerTooltip": "REALLNx", + "cellDataType": "number" + }, + { + "field": "REVOLSLx", + "headerName": "Total Real Revolving Credit Owned and Securitized, Outstanding (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "REVOLSLx", + "cellDataType": "number" + }, + { + "field": "TOTALSLx", + "headerName": "Total Consumer Credit Outstanding, deflated by Core PCE", + "headerTooltip": "TOTALSLx", + "cellDataType": "number" + }, + { + "field": "DRIWCIL", + "headerName": "FRB Senior Loans Officer Opions. Net Percentage of Domestic Respondents Reporting Increased Willingness to Make Consumer Installment Loans", + "headerTooltip": "DRIWCIL", + "cellDataType": "number" + }, + { + "field": "TABSHNOx", + "headerName": "Real Total Assets of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "TABSHNOx", + "cellDataType": "number" + }, + { + "field": "TLBSHNOx", + "headerName": "Real Total Liabilities of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "TLBSHNOx", + "cellDataType": "number" + }, + { + "field": "LIABPIx", + "headerName": "Liabilities of Households and Nonprofit Organizations Relative to Personal Disposable Income (Percent)", + "headerTooltip": "LIABPIx", + "cellDataType": "number" + }, + { + "field": "TNWBSHNOx", + "headerName": "Real Net Worth of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "TNWBSHNOx", + "cellDataType": "number" + }, + { + "field": "NWPIx", + "headerName": "Net Worth of Households and Nonprofit Organizations Relative to Disposable Personal Income (Percent)", + "headerTooltip": "NWPIx", + "cellDataType": "number" + }, + { + "field": "TARESAx", + "headerName": "Real Assets of Households and Nonprofit Organizations excluding Real Estate Assets (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "TARESAx", + "cellDataType": "number" + }, + { + "field": "HNOREMQ027Sx", + "headerName": "Real Real Estate Assets of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "HNOREMQ027Sx", + "cellDataType": "number" + }, + { + "field": "TFAABSHNOx", + "headerName": "Real Total Financial Assets of Households and Nonprofit Organizations (Billions of 2017 Dollars), deflated by Core PCE", + "headerTooltip": "TFAABSHNOx", + "cellDataType": "number" + }, + { + "field": "VIXCLSx", + "headerName": "CBOE Volatility Index: VIX", + "headerTooltip": "VIXCLSx", + "cellDataType": "number" + }, + { + "field": "USSTHPI", + "headerName": "All-Transactions House Price Index for the United States (Index 1980 Q1=100)", + "headerTooltip": "USSTHPI", + "cellDataType": "number" + }, + { + "field": "SPCS10RSA", + "headerName": "S&P/Case-Shiller 10-City Composite Home Price Index (Index January 2000 = 100)", + "headerTooltip": "SPCS10RSA", + "cellDataType": "number" + }, + { + "field": "SPCS20RSA", + "headerName": "S&P/Case-Shiller 20-City Composite Home Price Index (Index January 2000 = 100)", + "headerTooltip": "SPCS20RSA", + "cellDataType": "number" + }, + { + "field": "TWEXAFEGSMTHx", + "headerName": "Trade Weighted U.S. Dollar Index: Major Currencies (Index March 1973=100)", + "headerTooltip": "TWEXAFEGSMTHx", + "cellDataType": "number" + }, + { + "field": "EXUSEU", + "headerName": "U.S. / Euro Foreign Exchange Rate (U.S. Dollars to One Euro)", + "headerTooltip": "EXUSEU", + "cellDataType": "number" + }, + { + "field": "EXSZUSx", + "headerName": "Switzerland / U.S. Foreign Exchange Rate", + "headerTooltip": "EXSZUSx", + "cellDataType": "number" + }, + { + "field": "EXJPUSx", + "headerName": "Japan / U.S. Foreign Exchange Rate", + "headerTooltip": "EXJPUSx", + "cellDataType": "number" + }, + { + "field": "EXUSUKx", + "headerName": "U.S. / U.K. Foreign Exchange Rate", + "headerTooltip": "EXUSUKx", + "cellDataType": "number" + }, + { + "field": "EXCAUSx", + "headerName": "Canada / U.S. Foreign Exchange Rate", + "headerTooltip": "EXCAUSx", + "cellDataType": "number" + }, + { + "field": "UMCSENTx", + "headerName": "University of Michigan: Consumer Sentiment (Index 1st Quarter 1966=100)", + "headerTooltip": "UMCSENTx", + "cellDataType": "number" + }, + { + "field": "USEPUINDXM", + "headerName": "Economic Policy Uncertainty Index for United States", + "headerTooltip": "USEPUINDXM", + "cellDataType": "number" + }, + { + "field": "B020RE1Q156NBEA", + "headerName": "Shares of gross domestic product: Exports of goods and services (Percent)", + "headerTooltip": "B020RE1Q156NBEA", + "cellDataType": "number" + }, + { + "field": "B021RE1Q156NBEA", + "headerName": "Shares of gross domestic product: Imports of goods and services (Percent)", + "headerTooltip": "B021RE1Q156NBEA", + "cellDataType": "number" + }, + { + "field": "GFDEGDQ188S", + "headerName": "Federal Debt: Total Public Debt as Percent of GDP (Percent)", + "headerTooltip": "GFDEGDQ188S", + "cellDataType": "number" + }, + { + "field": "GFDEBTNx", + "headerName": "Real Federal Debt: Total Public Debt (Millions of 2017 Dollars), deflated by PCE", + "headerTooltip": "GFDEBTNx", + "cellDataType": "number" + }, + { + "field": "IPMANSICS", + "headerName": "Industrial Production: Manufacturing (SIC) (Index 2017=100)", + "headerTooltip": "IPMANSICS", + "cellDataType": "number" + }, + { + "field": "IPB51222S", + "headerName": "Industrial Production: Residential Utilities (Index 2017=100)", + "headerTooltip": "IPB51222S", + "cellDataType": "number" + }, + { + "field": "IPFUELS", + "headerName": "Industrial Production: Fuels (Index 2017=100)", + "headerTooltip": "IPFUELS", + "cellDataType": "number" + }, + { + "field": "UEMPMEAN", + "headerName": "Average (Mean) Duration of Unemployment (Weeks)", + "headerTooltip": "UEMPMEAN", + "cellDataType": "number" + }, + { + "field": "CES0600000007", + "headerName": "Average Weekly Hours of Production and Nonsupervisory Employees: Goods-Producing", + "headerTooltip": "CES0600000007", + "cellDataType": "number" + }, + { + "field": "TOTRESNS", + "headerName": "Total Reserves of Depository Institutions (Billions of Dollars)", + "headerTooltip": "TOTRESNS", + "cellDataType": "number" + }, + { + "field": "NONBORRES", + "headerName": "Reserves Of Depository Institutions, Nonborrowed (Millions of Dollars)", + "headerTooltip": "NONBORRES", + "cellDataType": "number" + }, + { + "field": "GS5", + "headerName": "5-Year Treasury Constant Maturity Rate", + "headerTooltip": "GS5", + "cellDataType": "number" + }, + { + "field": "TB3SMFFM", + "headerName": "3-Month Treasury Constant Maturity Minus Federal Funds Rate", + "headerTooltip": "TB3SMFFM", + "cellDataType": "number" + }, + { + "field": "T5YFFM", + "headerName": "5-Year Treasury Constant Maturity Minus Federal Funds Rate", + "headerTooltip": "T5YFFM", + "cellDataType": "number" + }, + { + "field": "AAAFFM", + "headerName": "Moody's Seasoned Aaa Corporate Bond Minus Federal Funds Rate", + "headerTooltip": "AAAFFM", + "cellDataType": "number" + }, + { + "field": "WPSID62", + "headerName": "Producer Price Index: Crude Materials for Further Processing (Index 1982=100)", + "headerTooltip": "WPSID62", + "cellDataType": "number" + }, + { + "field": "PPICMM", + "headerName": "Producer Price Index: Commodities: Metals and metal products: Primary nonferrous metals (Index 1982=100)", + "headerTooltip": "PPICMM", + "cellDataType": "number" + }, + { + "field": "CPIAPPSL", + "headerName": "Consumer Price Index for All Urban Consumers: Apparel (Index 1982-84=100)", + "headerTooltip": "CPIAPPSL", + "cellDataType": "number" + }, + { + "field": "CPITRNSL", + "headerName": "Consumer Price Index for All Urban Consumers: Transportation (Index 1982-84=100)", + "headerTooltip": "CPITRNSL", + "cellDataType": "number" + }, + { + "field": "CPIMEDSL", + "headerName": "Consumer Price Index for All Urban Consumers: Medical Care (Index 1982-84=100)", + "headerTooltip": "CPIMEDSL", + "cellDataType": "number" + }, + { + "field": "CUSR0000SAC", + "headerName": "Consumer Price Index for All Urban Consumers: Commodities (Index 1982-84=100)", + "headerTooltip": "CUSR0000SAC", + "cellDataType": "number" + }, + { + "field": "CUSR0000SAD", + "headerName": "Consumer Price Index for All Urban Consumers: Durables (Index 1982-84=100)", + "headerTooltip": "CUSR0000SAD", + "cellDataType": "number" + }, + { + "field": "CUSR0000SAS", + "headerName": "Consumer Price Index for All Urban Consumers: Services (Index 1982-84=100)", + "headerTooltip": "CUSR0000SAS", + "cellDataType": "number" + }, + { + "field": "CPIULFSL", + "headerName": "Consumer Price Index for All Urban Consumers: All Items Less Food (Index 1982-84=100)", + "headerTooltip": "CPIULFSL", + "cellDataType": "number" + }, + { + "field": "CUSR0000SA0L2", + "headerName": "Consumer Price Index for All Urban Consumers: All items less shelter (Index 1982-84=100)", + "headerTooltip": "CUSR0000SA0L2", + "cellDataType": "number" + }, + { + "field": "CUSR0000SA0L5", + "headerName": "Consumer Price Index for All Urban Consumers: All items less medical care (Index 1982-84=100)", + "headerTooltip": "CUSR0000SA0L5", + "cellDataType": "number" + }, + { + "field": "CES0600000008", + "headerName": "Average Hourly Earnings of Production and Nonsupervisory Employees: Goods-Producing (Dollars per Hour)", + "headerTooltip": "CES0600000008", + "cellDataType": "number" + }, + { + "field": "DTCOLNVHFNM", + "headerName": "Consumer Motor Vehicle Loans Outstanding Owned by Finance Companies (Millions of Dollars)", + "headerTooltip": "DTCOLNVHFNM", + "cellDataType": "number" + }, + { + "field": "DTCTHFNM", + "headerName": "Total Consumer Loans and Leases Outstanding Owned and Securitized by Finance Companies (Millions of Dollars)", + "headerTooltip": "DTCTHFNM", + "cellDataType": "number" + }, + { + "field": "INVEST", + "headerName": "Securities in Bank Credit at All Commercial Banks (Billions of Dollars)", + "headerTooltip": "INVEST", + "cellDataType": "number" + }, + { + "field": "HWIURATIOx", + "headerName": "Ratio of Help Wanted/No. Unemployed", + "headerTooltip": "HWIURATIOx", + "cellDataType": "number" + }, + { + "field": "CLAIMSx", + "headerName": "Initial Claims", + "headerTooltip": "CLAIMSx", + "cellDataType": "number" + }, + { + "field": "BUSINVx", + "headerName": "Total Business Inventories (Millions of Dollars)", + "headerTooltip": "BUSINVx", + "cellDataType": "number" + }, + { + "field": "ISRATIOx", + "headerName": "Total Business: Inventories to Sales Ratio", + "headerTooltip": "ISRATIOx", + "cellDataType": "number" + }, + { + "field": "CONSPIx", + "headerName": "Nonrevolving consumer credit to Personal Income", + "headerTooltip": "CONSPIx", + "cellDataType": "number" + }, + { + "field": "CP3M", + "headerName": "3-Month AA Financial Commercial Paper Rate", + "headerTooltip": "CP3M", + "cellDataType": "number" + }, + { + "field": "COMPAPFF", + "headerName": "3-Month Commercial Paper Minus Federal Funds Rate", + "headerTooltip": "COMPAPFF", + "cellDataType": "number" + }, + { + "field": "PERMITNE", + "headerName": "New Private Housing Units Authorized by Building Permits in the Northeast Census Region (Thousands, SAAR)", + "headerTooltip": "PERMITNE", + "cellDataType": "number" + }, + { + "field": "PERMITMW", + "headerName": "New Private Housing Units Authorized by Building Permits in the Midwest Census Region (Thousands, SAAR)", + "headerTooltip": "PERMITMW", + "cellDataType": "number" + }, + { + "field": "PERMITS", + "headerName": "New Private Housing Units Authorized by Building Permits in the South Census Region (Thousands, SAAR)", + "headerTooltip": "PERMITS", + "cellDataType": "number" + }, + { + "field": "PERMITW", + "headerName": "New Private Housing Units Authorized by Building Permits in the West Census Region (Thousands, SAAR)", + "headerTooltip": "PERMITW", + "cellDataType": "number" + }, + { + "field": "NIKKEI225", + "headerName": "Nikkei Stock Average", + "headerTooltip": "NIKKEI225", + "cellDataType": "number" + }, + { + "field": "NASDAQCOM", + "headerName": "NASDAQ Composite (Index Feb 5, 1971=100)", + "headerTooltip": "NASDAQCOM", + "cellDataType": "number" + }, + { + "field": "CUSR0000SEHC", + "headerName": "CPI for All Urban Consumers: Owners' equivalent rent of residences (Index Dec 1982=100)", + "headerTooltip": "CUSR0000SEHC", + "cellDataType": "number" + }, + { + "field": "TLBSNNCBx", + "headerName": "Real Nonfinancial Corporate Business Sector Liabilities (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "headerTooltip": "TLBSNNCBx", + "cellDataType": "number" + }, + { + "field": "TLBSNNCBBDIx", + "headerName": "Nonfinancial Corporate Business Sector Liabilities to Disposable Business Income (Percent)", + "headerTooltip": "TLBSNNCBBDIx", + "cellDataType": "number" + }, + { + "field": "TTAABSNNCBx", + "headerName": "Real Nonfinancial Corporate Business Sector Assets (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "headerTooltip": "TTAABSNNCBx", + "cellDataType": "number" + }, + { + "field": "TNWMVBSNNCBx", + "headerName": "Real Nonfinancial Corporate Business Sector Net Worth (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "headerTooltip": "TNWMVBSNNCBx", + "cellDataType": "number" + }, + { + "field": "TNWMVBSNNCBBDIx", + "headerName": "Nonfinancial Corporate Business Sector Net Worth to Disposable Business Income (Percent)", + "headerTooltip": "TNWMVBSNNCBBDIx", + "cellDataType": "number" + }, + { + "field": "TLBSNNBx", + "headerName": "Real Nonfinancial Noncorporate Business Sector Liabilities (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "headerTooltip": "TLBSNNBx", + "cellDataType": "number" + }, + { + "field": "TLBSNNBBDIx", + "headerName": "Nonfinancial Noncorporate Business Sector Liabilities to Disposable Business Income (Percent)", + "headerTooltip": "TLBSNNBBDIx", + "cellDataType": "number" + }, + { + "field": "TABSNNBx", + "headerName": "Real Nonfinancial Noncorporate Business Sector Assets (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "headerTooltip": "TABSNNBx", + "cellDataType": "number" + }, + { + "field": "TNWBSNNBx", + "headerName": "Real Nonfinancial Noncorporate Business Sector Net Worth (Billions of 2017 Dollars), Deflated by Implicit Price Deflator for Business Sector IPDBS", + "headerTooltip": "TNWBSNNBx", + "cellDataType": "number" + }, + { + "field": "TNWBSNNBBDIx", + "headerName": "Nonfinancial Noncorporate Business Sector Net Worth to Disposable Business Income (Percent)", + "headerTooltip": "TNWBSNNBBDIx", + "cellDataType": "number" + }, + { + "field": "CNCFx", + "headerName": "Real Disposable Business Income, Billions of 2017 Dollars (Corporate cash flow with IVA minus taxes on corporate income, deflated by Implicit Price Deflator for Business Sector IPDBS)", + "headerTooltip": "CNCFx", + "cellDataType": "number" + }, + { + "field": "S&P 500", + "headerName": "S&P's Common Stock Price Index: Composite", + "headerTooltip": "S&P 500", + "cellDataType": "number" + }, + { + "field": "S&P div yield", + "headerName": "S&P's Composite Common Stock: Dividend Yield", + "headerTooltip": "S&P div yield", + "cellDataType": "number" + }, + { + "field": "S&P PE ratio", + "headerName": "S&P's Composite Common Stock: Price-Earnings Ratio", + "headerTooltip": "S&P PE ratio", + "cellDataType": "number" + } + ] + } + } + }, + "model": "FederalReserveStLouisFredQd" + } + }, + "/federal_reserve/stl/national_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a St. Louis Fed national index: financial stress, price pressures, or nowcast.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The St. Louis Fed Financial Stress Index (weekly).\nobb.federal_reserve.stl.national_index(index='financial_stress_index', provider='federal_reserve')\n# The Price Pressures Measure (monthly).\nobb.federal_reserve.stl.national_index(index='price_pressures', provider='federal_reserve')\n# The Economic News Index real-GDP nowcast (quarterly).\nobb.federal_reserve.stl.national_index(index='economic_news_index', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "index", + "type": "str | None | list[str | None]", + "description": "One or more indexes (columns) to return; the default returns all three: 'financial_stress_index' (STLFSI4, weekly), 'price_pressures' (STLPPM, monthly), and 'economic_news_index' (STLENI, quarterly). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Financial Stress Index", + "value": "financial_stress_index" + }, + { + "label": "Price Pressures", + "value": "price_pressures" + }, + { + "label": "Economic News Index", + "value": "economic_news_index" + } + ], + "multiSelect": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveStLouisNationalIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | str", + "description": "The observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "financial_stress_index", + "type": "float | None", + "description": "St. Louis Fed Financial Stress Index (STLFSI4, weekly).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_pressures", + "type": "float | None", + "description": "St. Louis Fed Price Pressures Measure (STLPPM, monthly).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "economic_news_index", + "type": "float | None", + "description": "St. Louis Fed Economic News Index real-GDP nowcast (STLENI, quarterly).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveStLouisNationalIndex", + "openapi_extra": { + "widget_config": { + "name": "St. Louis Fed National Indexes", + "description": "A selected St. Louis Fed national index: the Financial Stress Index, the Price Pressures Measure, or the Economic News nowcast.", + "subCategory": "National Indexes", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "date", + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "sort": "desc" + }, + { + "field": "financial_stress_index", + "headerName": "Financial Stress Index", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "price_pressures", + "headerName": "Price Pressures", + "cellDataType": "number", + "formatterFn": "none" + }, + { + "field": "economic_news_index", + "headerName": "Economic News Index", + "cellDataType": "number", + "formatterFn": "none" + } + ] + } + } + }, + "model": "FederalReserveStLouisNationalIndex" + } + }, + "/federal_reserve/stl/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Index the St. Louis Fed Economic Synopses PDF archive on FRASER.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.federal_reserve.stl.publications(provider='federal_reserve')\n# Filter the catalog to a date range.\nobb.federal_reserve.stl.publications(start_date='2024-01-01', end_date='2024-12-31', provider='federal_reserve')\n```\n\n", + "parameters": { + "standard": [], + "federal_reserve": [ + { + "name": "series", + "type": "str | None", + "description": "Filter the catalog by publication series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Working Papers", + "value": "working_papers" + }, + { + "label": "Review", + "value": "review" + }, + { + "label": "Speech", + "value": "speech" + }, + { + "label": "Economic Synopses", + "value": "economic_synopses" + }, + { + "label": "National Economic Trends", + "value": "national_economic_trends" + }, + { + "label": "Page One Economics Newsletter", + "value": "page_one_economics" + }, + { + "label": "Burgundy Books", + "value": "burgundy_books" + }, + { + "label": "Bridges", + "value": "bridges" + }, + { + "label": "Monetary Trends", + "value": "monetary_trends" + }, + { + "label": "Proceedings", + "value": "proceedings" + }, + { + "label": "Community Development Publications and Reports", + "value": "community_development" + }, + { + "label": "Central Banker", + "value": "central_banker" + }, + { + "label": "Regional Economic Development", + "value": "regional_economic_development" + }, + { + "label": "Inside the Vault", + "value": "inside_the_vault" + }, + { + "label": "Annual Report", + "value": "annual_report" + }, + { + "label": "International Economic Trends", + "value": "international_economic_trends" + }, + { + "label": "Liber8 Economic Information Newsletter", + "value": "liber8" + }, + { + "label": "In the Balance", + "value": "in_the_balance" + }, + { + "label": "Economic Equity Insights", + "value": "economic_equity_insights" + }, + { + "label": "Quarterly Debt Monitor", + "value": "quarterly_debt_monitor" + }, + { + "label": "Demographics of Wealth", + "value": "demographics_of_wealth" + } + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of documents to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The result offset to begin from, for pagination.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FederalReserveStLouisPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "federal_reserve": [ + { + "name": "date", + "type": "date | None | str", + "description": "The publication date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str", + "description": "The publication series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The human-readable publication title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The direct URL to the publication document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FederalReserveStLouisPublications", + "openapi_extra": { + "model": "FederalReserveStLouisPublications" + } + }, + "/finra/equity/securities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List every FINRA-traded security by type - stocks, ETFs, and closed-end funds.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every traded security, with its type.\nobb.finra.equity.securities(provider='finra')\n# Every traded ETF.\nobb.finra.equity.securities(security_type='etf', provider='finra')\n```\n\n", + "parameters": { + "standard": [], + "finra": [ + { + "name": "security_type", + "type": "str | None", + "description": "The type of security to list. Other is every symbol without a stock, ETF, or closed-end fund type - warrants, rights, units, and securities the Market Data Center does not classify.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraEquityList", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "finra": [ + { + "name": "symbol", + "type": "str", + "description": "The FINRA symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The Morningstar name of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_name", + "type": "str | None", + "description": "The FINRA name of the issue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The Morningstar security type - Stock, ETF, Closed-End Fund, or Open-End Fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_description", + "type": "str | None", + "description": "The share class, or the Morningstar category of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tier", + "type": "str | None", + "description": "The FINRA tier - NMS Tier 1, NMS Tier 2, or OTC equities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "The FINRA product type - Nasdaq-listed, NYSE and regional exchange-listed, or OTC equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The Market Identifier Code of the listing venue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "listing_market", + "type": "str | None", + "description": "The Market Data Center name of the listing exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "composite_market", + "type": "str | None", + "description": "The Market Data Center name of the composite market.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The ISO 3166 alpha-3 code of the listing region.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "domicile", + "type": "str | None", + "description": "The ISO 3166 alpha-3 code of the domicile.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_id", + "type": "str | None", + "description": "The Morningstar security id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "performance_id", + "type": "str | None", + "description": "The Morningstar performance id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_symbol", + "type": "str | None", + "description": "The real-time quote key - composite market, type, and symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The security's page on the FINRA Market Data Center.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraEquityList", + "openapi_extra": { + "widget_config": { + "name": "FINRA Security List", + "description": "Every FINRA-traded stock, ETF, and closed-end fund, by type.", + "category": "Equity", + "subCategory": "Reference", + "source": [ + "FINRA" + ] + }, + "model": "FinraEquityList" + } + }, + "/finra/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search stocks and funds in the FINRA Market Data Center.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search securities by symbol, name, or ISIN.\nobb.finra.equity.search(query='apple', provider='finra')\n# Search only ETFs.\nobb.finra.equity.search(query='SPY', security_type='etf', provider='finra')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "security_type", + "type": "str | None", + "description": "The type of security to search for.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraEquitySearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "security_type", + "type": "str | None", + "description": "The Morningstar security type - Stock, ETF, Closed-End Fund, or Open-End Fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_description", + "type": "str | None", + "description": "The share class, or the Morningstar category of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The ISO 3166 alpha-3 code of the listing country.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "The International Securities Identification Number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_id", + "type": "str | None", + "description": "The Morningstar security id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "performance_id", + "type": "str | None", + "description": "The Morningstar performance id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The Market Identifier Code of the listing venue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "listing_market", + "type": "str | None", + "description": "The Market Data Center name of the listing exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "composite_market", + "type": "str | None", + "description": "The Market Data Center name of the composite market.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_symbol", + "type": "str | None", + "description": "The real-time quote key - composite market, type, and symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The security's page on the FINRA Market Data Center.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraEquitySearch", + "openapi_extra": { + "widget_config": { + "name": "FINRA Security Search", + "description": "Search stocks and funds by symbol, name, or ISIN.", + "category": "Equity", + "subCategory": "Search", + "source": [ + "FINRA" + ] + }, + "model": "FinraEquitySearch" + } + }, + "/finra/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get identifiers, classification, prices, dividends, and ratios for securities.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The reference profile of a stock.\nobb.finra.equity.profile(symbol='AAPL', provider='finra')\n# Profiles for several securities at once.\nobb.finra.equity.profile(symbol='AAPL,SPY,VFIAX', provider='finra')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finra.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "multiple_items_allowed": true + } + } + } + ], + "finra": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraEquityInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Common name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legal_name", + "type": "str | None", + "description": "Official legal name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_exchange", + "type": "str | None", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sic", + "type": "int | None", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_description", + "type": "str | None", + "description": "Short description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_description", + "type": "str | None", + "description": "Long description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ceo", + "type": "str | None", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_url", + "type": "str | None", + "description": "URL of the company's website.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_address", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mailing_address", + "type": "str | None", + "description": "Mailing address of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_phone_no", + "type": "str | None", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address1", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address2", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_city", + "type": "str | None", + "description": "City of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_postal_code", + "type": "str | None", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_state", + "type": "str | None", + "description": "State of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_country", + "type": "str | None", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_state", + "type": "str | None", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_country", + "type": "str | None", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employees", + "type": "int | None", + "description": "Number of employees working for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_legal_form", + "type": "str | None", + "description": "Legal form of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_status", + "type": "str | None", + "description": "Status of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_filing_date", + "type": "date | None", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "irs_number", + "type": "str | None", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_category", + "type": "str | None", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "template", + "type": "str | None", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standardized_active", + "type": "bool | None", + "description": "Whether the company is active or not.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_fundamental_date", + "type": "date | None", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_fundamental_date", + "type": "date | None", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_stock_price_date", + "type": "date | None", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_stock_price_date", + "type": "date | None", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "security_type", + "type": "str | None", + "description": "The Morningstar security type - Stock, ETF, Closed-End Fund, Open-End Fund, or Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_description", + "type": "str | None", + "description": "The share class, or the Morningstar category of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_id", + "type": "str | None", + "description": "The Morningstar security id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "performance_id", + "type": "str | None", + "description": "The Morningstar performance id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_id", + "type": "str | None", + "description": "The Morningstar company or fund id.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_symbol", + "type": "str | None", + "description": "The real-time quote key - composite market, type, and symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_name", + "type": "str | None", + "description": "The name of the listing exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "The ISO 3166 alpha-3 code of the listing region.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "domicile", + "type": "str | None", + "description": "The ISO 3166 alpha-3 code of the domicile.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_adr", + "type": "bool | None", + "description": "Whether the security is a depositary receipt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ipo_date", + "type": "date | None", + "description": "The IPO date of a stock, or the inception date of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year_end_month", + "type": "str | None", + "description": "The month the fiscal year ends.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gics_sector", + "type": "str | None", + "description": "The GICS sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gics_industry", + "type": "str | None", + "description": "The GICS industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gics_sub_industry", + "type": "str | None", + "description": "The GICS sub-industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fund_category", + "type": "str | None", + "description": "The Morningstar category of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last closing price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price_date", + "type": "date | None", + "description": "The date of the last closing price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_one_week_ago", + "type": "float | None", + "description": "The closing price one week before.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nav", + "type": "float | None", + "description": "The net asset value per share of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_high", + "type": "float | None", + "description": "The 52-week high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_high_date", + "type": "date | None", + "description": "The date of the 52-week high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The 52-week low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low_date", + "type": "date | None", + "description": "The date of the 52-week low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_outstanding", + "type": "float | None", + "description": "The number of shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market capitalization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_assets", + "type": "float | None", + "description": "The total net assets of a fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_volume", + "type": "float | None", + "description": "The average daily share volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_dividend", + "type": "float | None", + "description": "The most recent dividend per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trailing_dividend", + "type": "float | None", + "description": "The dividends per share over the trailing year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "The trailing dividend yield, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "forward_dividend_yield", + "type": "float | None", + "description": "The forward dividend yield, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "dividend_frequency", + "type": "str | None", + "description": "How often the dividend is paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ex_dividend_date", + "type": "date | None", + "description": "The ex-date of the most recent dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_declaration_date", + "type": "date | None", + "description": "The declaration date of the most recent dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_payment_date", + "type": "date | None", + "description": "The payment date of the most recent dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_ttm", + "type": "float | None", + "description": "The trailing twelve-month earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pe_ratio", + "type": "float | None", + "description": "The trailing price-to-earnings ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_book", + "type": "float | None", + "description": "The price-to-book ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_sales", + "type": "float | None", + "description": "The price-to-sales ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_cash_flow", + "type": "float | None", + "description": "The price-to-cash-flow ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_free_cash_flow", + "type": "float | None", + "description": "The price-to-free-cash-flow ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expense_ratio", + "type": "float | None", + "description": "The net expense ratio of a fund, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "morningstar_rating", + "type": "int | None", + "description": "The Morningstar star rating, from 1 to 5.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "valuation", + "type": "str | None", + "description": "The Morningstar quantitative valuation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volatility_1y", + "type": "float | None", + "description": "The standard deviation of returns over one year, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "volatility_3y", + "type": "float | None", + "description": "The standard deviation of returns over three years, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "url", + "type": "str | None", + "description": "The security's page on the FINRA Market Data Center.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraEquityInfo", + "openapi_extra": { + "widget_config": { + "name": "FINRA Security Profile", + "description": "Identifiers, classification, prices, dividends, and ratios.", + "category": "Equity", + "subCategory": "Profile", + "source": [ + "FINRA" + ] + }, + "model": "FinraEquityInfo" + } + }, + "/finra/equity/darkpool/otc": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the weekly OTC and ATS trading volume reported to FINRA.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The weekly ATS volume of a symbol.\nobb.finra.equity.darkpool.otc(symbol='AAPL', provider='finra')\n# The latest week of non-ATS volume for every Tier 2 stock.\nobb.finra.equity.darkpool.otc(tier='T2', is_ats=False, provider='finra')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finra.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "multiple_items_allowed": true + } + } + } + ], + "finra": [ + { + "name": "tier", + "type": "str | None", + "description": "T1 - NMS stocks in the S&P 500, Russell 1000, and selected ETPs; T2 - all other NMS stocks; OTCE - OTC equity securities.", + "default": "T1", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_ats", + "type": "bool | None", + "description": "Alternative Trading System (ATS) volume when True, other OTC (non-ATS) volume when False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraOTCAggregate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "update_date", + "type": "date", + "description": "Most recent date on which total trades is updated based on data received from each ATS/OTC.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "share_quantity", + "type": "float", + "description": "Aggregate weekly total number of shares reported by each ATS for the Symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trade_quantity", + "type": "float", + "description": "Aggregate weekly total number of trades reported by each ATS for the Symbol", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "week_start_date", + "type": "date", + "description": "The first business day (Monday) of the reported week.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issue_name", + "type": "str | None", + "description": "The name of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tier", + "type": "str | None", + "description": "The tier the security was reported under.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "The product type - Nasdaq-listed, NYSE and regional exchange-listed, or OTC equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_notional", + "type": "float | None", + "description": "The aggregate weekly notional value of the reported trades.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "initial_published_date", + "type": "date | None", + "description": "The date the week was first published.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_reported_date", + "type": "date | None", + "description": "The most recent date a trade was reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraOTCAggregate", + "openapi_extra": { + "widget_config": { + "name": "FINRA OTC and ATS Volume", + "description": "Weekly OTC and ATS share and trade volume.", + "category": "Equity", + "subCategory": "Dark Pools", + "source": [ + "FINRA" + ] + }, + "model": "FinraOTCAggregate" + } + }, + "/finra/equity/shorts/short_interest": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the bi-monthly consolidated short interest and days to cover.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The bi-monthly short interest of a symbol.\nobb.finra.equity.shorts.short_interest(symbol='AAPL', provider='finra')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): finra.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "multiple_items_allowed": true + } + } + } + ], + "finra": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraEquityShortInterest", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issue_name", + "type": "str", + "description": "Unique identifier of the issue.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "market_class", + "type": "str", + "description": "Primary listing market.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "current_short_position", + "type": "float", + "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle\u2019s designated settlement date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "previous_short_position", + "type": "float", + "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle\u2019s designated settlement date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "avg_daily_volume", + "type": "float", + "description": "Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "days_to_cover", + "type": "float", + "description": "The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float", + "description": "Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change_pct", + "type": "float", + "description": "Change in Shares Short from Previous Cycle as a percent.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "revised", + "type": "bool | None", + "description": "Whether FINRA revised the cycle after it was first published.", + "default": false, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_split", + "type": "bool | None", + "description": "Whether a stock split occurred during the cycle.", + "default": false, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraEquityShortInterest", + "openapi_extra": { + "widget_config": { + "name": "FINRA Short Interest", + "description": "Bi-monthly consolidated short interest and days to cover.", + "category": "Equity", + "subCategory": "Shorts", + "source": [ + "FINRA" + ] + }, + "model": "FinraEquityShortInterest" + } + }, + "/finra/fixedincome/bond_historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the daily end-of-day TRACE price and yield of bonds.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Five years of end-of-day prices and yields for a bond.\nobb.finra.fixedincome.bond_historical(cusip='037833EH9', provider='finra')\n# A window of history for a bond by its FINRA symbol.\nobb.finra.fixedincome.bond_historical(cusip='AAPL5231623', start_date='2026-01-01', end_date='2026-06-30', provider='finra')\n```\n\n", + "parameters": { + "standard": [], + "finra": [ + { + "name": "cusip", + "type": "str | list[str]", + "description": "The CUSIP or FINRA symbol of the bond. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The first trade date. Five years before the end date when empty.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The last trade date. Today when empty.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraBondHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "finra": [ + { + "name": "date", + "type": "date | str", + "description": "The trade date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the bond.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The FINRA symbol of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finra_security_id", + "type": "str | None", + "description": "The FINRA security identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "The TRACE product - Corporate and Agency, Securitized Products, or U.S. Treasury.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the last sale of the day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_sale_yield", + "type": "float | None", + "description": "The yield of the last sale of the day, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "yield_direction", + "type": "str | None", + "description": "The direction of the day's yield change.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraBondHistorical", + "openapi_extra": { + "widget_config": { + "name": "FINRA TRACE Bond History", + "description": "End-of-day TRACE prices and yields of a bond.", + "category": "Fixed Income", + "subCategory": "Corporate Bonds", + "source": [ + "FINRA" + ] + }, + "model": "FinraBondHistorical" + } + }, + "/finra/fixedincome/bonds": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List every TRACE-reported bond of one type, with its reference data and last sale.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every outstanding corporate and agency bond.\nobb.finra.fixedincome.bonds(provider='finra')\n# Every Treasury note and bond, matured ones included.\nobb.finra.fixedincome.bonds(bond_type='TS', include_matured=True, provider='finra')\n```\n\n", + "parameters": { + "standard": [], + "finra": [ + { + "name": "bond_type", + "type": "str | None", + "description": "The TRACE product - CA (corporate and agency), TS (U.S. Treasury), TBA, MBS, ABS, or CMO.", + "default": "CA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_matured", + "type": "bool | None", + "description": "Include the bonds that have matured.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraBondList", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier of the issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "figi", + "type": "str | None", + "description": "FIGI of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_rate", + "type": "float | None", + "description": "Coupon rate of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "price", + "type": "float | None", + "description": "Price of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "current_yield", + "type": "float | None", + "description": "Current yield of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ytm", + "type": "float | None", + "description": "Yield to maturity of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ytw", + "type": "float | None", + "description": "Yield to worst of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "duration", + "type": "float | None", + "description": "Duration of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Maturity date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_date", + "type": "date | None", + "description": "The nearest call date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "coupon_rate", + "type": "float | None", + "description": "The coupon rate of the bond, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the last reported sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bond_type", + "type": "str", + "description": "The TRACE product of the bond - Corporate & Agency, U.S. Treasury, To-Be-Announced MBS, Mortgage-Backed, Asset-Backed, or Collateralized Mortgage Obligations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The FINRA symbol of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finra_security_id", + "type": "str | None", + "description": "The FINRA security identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_name", + "type": "str | None", + "description": "The name of the issuer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuing_agency", + "type": "str | None", + "description": "The issuing agency, or trust, of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_description", + "type": "str | None", + "description": "The description of the issue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_description", + "type": "str | None", + "description": "The description of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "The product type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_sub_type", + "type": "str | None", + "description": "The product sub-type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sub_product_type", + "type": "str | None", + "description": "The sub-product type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_type", + "type": "str | None", + "description": "The coupon type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_type", + "type": "str | None", + "description": "The interest type code of an asset-backed tranche.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_perpetual", + "type": "bool | None", + "description": "Whether the bond has no maturity date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_callable", + "type": "bool | None", + "description": "Whether the bond is callable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_convertible", + "type": "bool | None", + "description": "Whether the bond is convertible.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_144a", + "type": "bool | None", + "description": "Whether the bond is a Rule 144A security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "The industry group of the issuer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "grade", + "type": "str | None", + "description": "The TRACE grade - investment grade or high yield.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "moodys_rating", + "type": "str | None", + "description": "The Moody's rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "moodys_rating_date", + "type": "date | None", + "description": "The date of the Moody's rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sp_rating", + "type": "str | None", + "description": "The S&P rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sp_rating_date", + "type": "date | None", + "description": "The date of the S&P rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "benchmark_term", + "type": "str | None", + "description": "The benchmark term of a Treasury security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_type", + "type": "str | None", + "description": "How the last sale was priced - Decimal, Yield, or Negative Yield.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_sale_yield", + "type": "float | None", + "description": "The yield of the last reported sale, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "last_trade_date", + "type": "date | None", + "description": "The date of the last reported sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "str | None", + "description": "The time of the last reported sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change", + "type": "float | None", + "description": "The change in the last sale price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change_percent", + "type": "float | None", + "description": "The change in the last sale price, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "settlement_month", + "type": "str | None", + "description": "The settlement month of a TBA contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pool_number", + "type": "str | None", + "description": "The pool number of a mortgage-backed security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reference_data_id", + "type": "str | None", + "description": "The reference data identifier of the pool.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mortgage_product", + "type": "str | None", + "description": "The mortgage product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_type", + "type": "str | None", + "description": "The amortization type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_maturity_term", + "type": "float | None", + "description": "The original maturity term of the pool, in months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_average_coupon", + "type": "float | None", + "description": "The weighted average coupon of the pool, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "weighted_average_maturity", + "type": "float | None", + "description": "The weighted average maturity of the pool, in months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_average_loan_age", + "type": "float | None", + "description": "The weighted average loan age of the pool, in months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loan_to_value", + "type": "float | None", + "description": "The loan-to-value ratio of the pool, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_loan_size", + "type": "float | None", + "description": "The average loan size of the pool.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deal_id", + "type": "str | None", + "description": "The deal identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tranche_id", + "type": "str | None", + "description": "The tranche identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraBondList", + "openapi_extra": { + "widget_config": { + "name": "FINRA TRACE Bond List", + "description": "Every TRACE-reported bond of one type.", + "category": "Fixed Income", + "subCategory": "Reference", + "source": [ + "FINRA" + ] + }, + "model": "FinraBondList" + } + }, + "/finra/fixedincome/bond_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search TRACE-reported bonds, with reference data and the last reported sale.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Look up a bond by CUSIP; its TRACE product is detected.\nobb.finra.fixedincome.bond_prices(cusip='037833EH9', provider='finra')\n# Outstanding bonds of an issuer, matching every word.\nobb.finra.fixedincome.bond_prices(issuer_name='apple', provider='finra')\n# Treasury notes and bonds maturing within a window.\nobb.finra.fixedincome.bond_prices(bond_type='TS', maturity_date_min='2030-01-01', maturity_date_max='2035-12-31', provider='finra')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data. Matches partial name.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "x-widget_config": { + "exclude": true + } + } + } + }, + { + "name": "issuer_name", + "type": "str | None", + "description": "Name of the issuer. Returns partial matches and is case insensitive.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "list | str | None", + "description": "International Securities Identification Number(s) of the bond(s).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "x-widget_config": { + "exclude": true + } + } + } + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier of the issuing entity.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "x-widget_config": { + "exclude": true + } + } + } + }, + { + "name": "currency", + "type": "list | str | None", + "description": "Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "x-widget_config": { + "exclude": true + } + } + } + }, + { + "name": "coupon_min", + "type": "float | None", + "description": "Minimum coupon rate of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "coupon_max", + "type": "float | None", + "description": "Maximum coupon rate of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issued_amount_min", + "type": "int | None", + "description": "Minimum issued amount of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "x-widget_config": { + "exclude": true + } + } + } + }, + { + "name": "issued_amount_max", + "type": "str | None", + "description": "Maximum issued amount of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "finra": { + "x-widget_config": { + "exclude": true + } + } + } + }, + { + "name": "maturity_date_min", + "type": "date | None", + "description": "Minimum maturity date of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date_max", + "type": "date | None", + "description": "Maximum maturity date of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ytm_max", + "type": "float | None", + "description": "Maximum yield to maturity of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ytm_min", + "type": "float | None", + "description": "Minimum yield to maturity of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "cusip", + "type": "str | None | list[str | None]", + "description": "The CUSIP or FINRA symbol of the bond. The bond type is detected when it is not given. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "bond_type", + "type": "str | None", + "description": "The TRACE product - CA (corporate and agency), TS (U.S. Treasury), TBA, MBS, ABS, or CMO. Corporate and agency when neither this nor a cusip is given. Issuer names match the issuing agency for TBA and MBS.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_matured", + "type": "bool | None", + "description": "Include the bonds that have matured.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The most bonds to return. All when empty.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FinraBondPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier of the issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "figi", + "type": "str | None", + "description": "FIGI of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_rate", + "type": "float | None", + "description": "Coupon rate of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "price", + "type": "float | None", + "description": "Price of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "current_yield", + "type": "float | None", + "description": "Current yield of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ytm", + "type": "float | None", + "description": "Yield to maturity of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ytw", + "type": "float | None", + "description": "Yield to worst of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "duration", + "type": "float | None", + "description": "Duration of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Maturity date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_date", + "type": "date | None", + "description": "The nearest call date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "finra": [ + { + "name": "coupon_rate", + "type": "float | None", + "description": "The coupon rate of the bond, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the last reported sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bond_type", + "type": "str", + "description": "The TRACE product of the bond - Corporate & Agency, U.S. Treasury, To-Be-Announced MBS, Mortgage-Backed, Asset-Backed, or Collateralized Mortgage Obligations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The FINRA symbol of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finra_security_id", + "type": "str | None", + "description": "The FINRA security identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_name", + "type": "str | None", + "description": "The name of the issuer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuing_agency", + "type": "str | None", + "description": "The issuing agency, or trust, of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_description", + "type": "str | None", + "description": "The description of the issue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_description", + "type": "str | None", + "description": "The description of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_type", + "type": "str | None", + "description": "The product type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "product_sub_type", + "type": "str | None", + "description": "The product sub-type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sub_product_type", + "type": "str | None", + "description": "The sub-product type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_type", + "type": "str | None", + "description": "The coupon type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_type", + "type": "str | None", + "description": "The interest type code of an asset-backed tranche.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_perpetual", + "type": "bool | None", + "description": "Whether the bond has no maturity date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_callable", + "type": "bool | None", + "description": "Whether the bond is callable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_convertible", + "type": "bool | None", + "description": "Whether the bond is convertible.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_144a", + "type": "bool | None", + "description": "Whether the bond is a Rule 144A security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "The industry group of the issuer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "grade", + "type": "str | None", + "description": "The TRACE grade - investment grade or high yield.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "moodys_rating", + "type": "str | None", + "description": "The Moody's rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "moodys_rating_date", + "type": "date | None", + "description": "The date of the Moody's rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sp_rating", + "type": "str | None", + "description": "The S&P rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sp_rating_date", + "type": "date | None", + "description": "The date of the S&P rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "benchmark_term", + "type": "str | None", + "description": "The benchmark term of a Treasury security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_type", + "type": "str | None", + "description": "How the last sale was priced - Decimal, Yield, or Negative Yield.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_sale_yield", + "type": "float | None", + "description": "The yield of the last reported sale, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "last_trade_date", + "type": "date | None", + "description": "The date of the last reported sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "str | None", + "description": "The time of the last reported sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change", + "type": "float | None", + "description": "The change in the last sale price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change_percent", + "type": "float | None", + "description": "The change in the last sale price, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "settlement_month", + "type": "str | None", + "description": "The settlement month of a TBA contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pool_number", + "type": "str | None", + "description": "The pool number of a mortgage-backed security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reference_data_id", + "type": "str | None", + "description": "The reference data identifier of the pool.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mortgage_product", + "type": "str | None", + "description": "The mortgage product code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_type", + "type": "str | None", + "description": "The amortization type code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_maturity_term", + "type": "float | None", + "description": "The original maturity term of the pool, in months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_average_coupon", + "type": "float | None", + "description": "The weighted average coupon of the pool, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "weighted_average_maturity", + "type": "float | None", + "description": "The weighted average maturity of the pool, in months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_average_loan_age", + "type": "float | None", + "description": "The weighted average loan age of the pool, in months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loan_to_value", + "type": "float | None", + "description": "The loan-to-value ratio of the pool, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_loan_size", + "type": "float | None", + "description": "The average loan size of the pool.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deal_id", + "type": "str | None", + "description": "The deal identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tranche_id", + "type": "str | None", + "description": "The tranche identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FinraBondPrices", + "openapi_extra": { + "widget_config": { + "name": "FINRA TRACE Bonds", + "description": "TRACE-reported bonds with reference data and last sales.", + "category": "Fixed Income", + "subCategory": "Corporate Bonds", + "source": [ + "FINRA" + ] + }, + "model": "FinraBondPrices" + } + }, + "/fred/commodity/price/spot": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Commodity Spot Prices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.commodity.price.spot(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "commodity", + "type": "str | None", + "description": "Commodity name associated with the EIA spot price commodity data, default is 'all'.", + "default": "all", + "optional": true, + "choices": [ + "wti", + "brent", + "natural_gas", + "jet_fuel", + "propane", + "heating_oil", + "diesel_gulf_coast", + "diesel_ny_harbor", + "diesel_la", + "gasoline_ny_harbor", + "gasoline_gulf_coast", + "rbob", + "all" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": "eop", + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredCommoditySpotPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "Price of the commodity.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the commodity price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredCommoditySpotPrices", + "openapi_extra": { + "model": "FredCommoditySpotPrices" + } + }, + "/fred/fixedincome/corporate/commercial_paper": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Commercial Paper.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.corporate.commercial_paper(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "maturity", + "type": "str | None | list[str | None]", + "description": "A target maturity. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "overnight", + "7d", + "15d", + "30d", + "60d", + "90d" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None | list[str | None]", + "description": "The category of asset. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "asset_backed", + "financial", + "nonfinancial", + "a2p2" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredCommercialPaper", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "asset_backed_overnight", + "type": "float | None", + "description": "Overnight AA Asset-Backed Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overnight AA Asset-Backed Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "asset_backed_day_7", + "type": "float | None", + "description": "7-Day AA Asset-Backed Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "7-Day AA Asset-Backed Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "asset_backed_day_15", + "type": "float | None", + "description": "15-Day AA Asset-Backed Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15-Day AA Asset-Backed Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "asset_backed_day_30", + "type": "float | None", + "description": "30-Day AA Asset-Backed Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Day AA Asset-Backed Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "asset_backed_day_60", + "type": "float | None", + "description": "60-Day AA Asset-Backed Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "60-Day AA Asset-Backed Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "asset_backed_day_90", + "type": "float | None", + "description": "90-Day AA Asset-Backed Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "90-Day AA Asset-Backed Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "financial_overnight", + "type": "float | None", + "description": "Overnight AA Financial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overnight AA Financial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "financial_day_7", + "type": "float | None", + "description": "7-Day AA Financial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "7-Day AA Financial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "financial_day_15", + "type": "float | None", + "description": "15-Day AA Financial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15-Day AA Financial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "financial_day_30", + "type": "float | None", + "description": "30-Day AA Financial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Day AA Financial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "financial_day_60", + "type": "float | None", + "description": "60-Day AA Financial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "60-Day AA Financial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "financial_day_90", + "type": "float | None", + "description": "90-Day AA Financial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "90-Day AA Financial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "nonfinancial_overnight", + "type": "float | None", + "description": "Overnight AA Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overnight AA Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "nonfinancial_day_7", + "type": "float | None", + "description": "7-Day AA Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "7-Day AA Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "nonfinancial_day_15", + "type": "float | None", + "description": "15-Day AA Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15-Day AA Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "nonfinancial_day_30", + "type": "float | None", + "description": "30-Day AA Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Day AA Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "nonfinancial_day_60", + "type": "float | None", + "description": "60-Day AA Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "60-Day AA Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "nonfinancial_day_90", + "type": "float | None", + "description": "90-Day AA Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "90-Day AA Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "a2p2_overnight", + "type": "float | None", + "description": "Overnight A2/P2 Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Overnight A2/P2 Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "a2p2_day_7", + "type": "float | None", + "description": "7-Day A2/P2 Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "7-Day A2/P2 Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "a2p2_day_15", + "type": "float | None", + "description": "15-Day A2/P2 Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15-Day A2/P2 Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "a2p2_day_30", + "type": "float | None", + "description": "30-Day A2/P2 Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Day A2/P2 Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "a2p2_day_60", + "type": "float | None", + "description": "60-Day A2/P2 Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "60-Day A2/P2 Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "a2p2_day_90", + "type": "float | None", + "description": "90-Day A2/P2 Nonfinancial Commercial Paper Interest Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "90-Day A2/P2 Nonfinancial Commercial Paper Interest Rate", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FredCommercialPaper", + "openapi_extra": { + "model": "FredCommercialPaper" + } + }, + "/fred/fixedincome/corporate/hqm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "High Quality Market Corporate Bond.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.corporate.hqm(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. Multiple items allowed for provider(s): fred.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + } + ], + "fred": [ + { + "name": "yield_curve", + "type": "str | None", + "description": "The yield curve type.", + "default": "spot", + "optional": true, + "choices": [ + "spot", + "par" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "spot", + "par" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredHighQualityMarketCorporateBond", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Interest rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Interest rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + } + ] + }, + "model": "FredHighQualityMarketCorporateBond", + "openapi_extra": { + "model": "FredHighQualityMarketCorporateBond" + } + }, + "/fred/fixedincome/corporate/spot_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Spot Rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.corporate.spot_rates(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "float | str | None | list[float | str | None]", + "description": "Maturities in years. Multiple items allowed for provider(s): fred.", + "default": 10.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + }, + { + "name": "category", + "type": "str | None | list[str | None]", + "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", + "default": "spot_rate", + "optional": true, + "choices": [ + "par_yield", + "spot_rate" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true, + "choices": [ + "par_yield", + "spot_rate" + ] + } + } + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSpotRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the security.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "rate", + "type": "float | None", + "description": "Spot Rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredSpotRate", + "openapi_extra": { + "model": "FredSpotRate" + } + }, + "/fred/economy/release_table": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Read a published release table, with the periods across the columns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Advance retail sales by kind of business.\nobb.fred.economy.release_table(release_id='9', element_id='201241')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "release_id", + "type": "str", + "description": "The economic release to present.", + "default": "9", + "optional": true + }, + { + "name": "element_id", + "type": "str", + "description": "The table within the release. Without one, every series the release publishes is listed.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "The interval to present. A table reads at one interval; without a choice the one it mostly publishes is used.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "How many periods to present.", + "default": 8, + "optional": true + }, + { + "name": "symbol", + "type": "str", + "description": "The series the table groups on. Carried for the grouping, not read.", + "default": null, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "FRED Release Table", + "description": "A published release table, in its own line order and indentation, with the periods across the columns.", + "category": "Economy", + "subCategory": "Releases", + "params": [ + { + "paramName": "release_id", + "label": "Release", + "description": "The economic release to present.", + "type": "endpoint", + "value": "9", + "optionsEndpoint": "/api/v1/fred/economy/release_choices", + "style": { + "popupWidth": 1000 + } + }, + { + "paramName": "element_id", + "label": "Table", + "description": "The table within the release.", + "type": "endpoint", + "value": "201241", + "optionsEndpoint": "/api/v1/fred/economy/element_choices", + "optionsParams": { + "release_id": "$release_id" + }, + "style": { + "popupWidth": 1000 + } + }, + { + "paramName": "frequency", + "label": "Frequency", + "description": "The interval the table is presented at.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/fred/economy/frequency_choices", + "optionsParams": { + "release_id": "$release_id", + "element_id": "$element_id" + } + }, + { + "paramName": "symbol", + "show": false + } + ], + "gridData": { + "w": 40, + "h": 20 + }, + "refetchInterval": false, + "data": { + "table": { + "showAll": true, + "columnsDefs": [ + { + "field": "series", + "headerName": "Series", + "cellDataType": "text", + "pinned": "left", + "minWidth": 380 + }, + { + "field": "symbol", + "headerName": "Symbol", + "cellDataType": "text", + "width": 140, + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + }, + { + "field": "units", + "headerName": "Units", + "cellDataType": "text", + "width": 170 + }, + { + "field": "trend", + "headerName": "Trend", + "width": 170, + "sparkline": { + "type": "line", + "options": { + "stroke": "#2563eb", + "strokeWidth": 2, + "markers": { + "enabled": false + }, + "pointsOfInterest": { + "maximum": { + "fill": "#22c55e", + "stroke": "#16a34a", + "size": 5 + }, + "minimum": { + "fill": "#ef4444", + "stroke": "#dc2626", + "size": 5 + } + }, + "customFormatter": "(params) => ({})" + } + } + } + ] + } + } + }, + "model": "" + } + }, + "/fred/economy/balance_of_payments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Balance of Payments Reports.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.balance_of_payments(provider='fred')\n```\n\n", + "parameters": { + "standard": [], + "fred": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data. Enter as a 3-letter ISO country code, default is USA.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "czechia", + "denmark", + "estonia", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states", + "g7", + "g20" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredBalanceOfPayments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "date | None", + "description": "The date representing the beginning of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_percent_of_gdp", + "type": "float | None", + "description": "Current Account Balance as Percent of GDP", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "balance_total", + "type": "float | None", + "description": "Current Account Total Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_services", + "type": "float | None", + "description": "Current Account Total Services Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_secondary_income", + "type": "float | None", + "description": "Current Account Total Secondary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_goods", + "type": "float | None", + "description": "Current Account Total Goods Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_primary_income", + "type": "float | None", + "description": "Current Account Total Primary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_total_services", + "type": "float | None", + "description": "Current Account Credits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_goods", + "type": "float | None", + "description": "Current Account Credits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_primary_income", + "type": "float | None", + "description": "Current Account Credits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_secondary_income", + "type": "float | None", + "description": "Current Account Credits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total", + "type": "float | None", + "description": "Current Account Credits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_total_services", + "type": "float | None", + "description": "Current Account Debits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_goods", + "type": "float | None", + "description": "Current Account Debits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_primary_income", + "type": "float | None", + "description": "Current Account Debits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total", + "type": "float | None", + "description": "Current Account Debits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_secondary_income", + "type": "float | None", + "description": "Current Account Debits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "balance_percent_of_gdp", + "type": "float | None", + "description": "Current Account Balance as Percent of GDP", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "credits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "credits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "debits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "debits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FredBalanceOfPayments", + "openapi_extra": { + "model": "FredBalanceOfPayments" + } + }, + "/fred/economy/cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Consumer Price Index (CPI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.cpi(country='united_states', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", + "default": "united_states", + "optional": true, + "choices": [ + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "croatia", + "cyprus", + "czech_republic", + "denmark", + "estonia", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "malta", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "romania", + "russian_federation", + "slovak_republic", + "slovakia", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true, + "choices": [ + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "croatia", + "cyprus", + "czech_republic", + "denmark", + "estonia", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "malta", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "romania", + "russian_federation", + "slovak_republic", + "slovakia", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states" + ] + } + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation of the CPI data.", + "default": "yoy", + "optional": true, + "choices": [ + "index", + "yoy", + "period" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "choices": [ + "index", + "yoy", + "period" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "harmonized", + "type": "bool | None", + "description": "If true, returns harmonized data.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredConsumerPriceIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "None", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "CPI index value or period change.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredConsumerPriceIndex", + "openapi_extra": { + "model": "FredConsumerPriceIndex" + } + }, + "/fred/economy/calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Economic release calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.calendar(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "release_id", + "type": "int | None", + "description": "Filter by release ID.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredEconomicCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Category of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "event", + "type": "str | None", + "description": "Event name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "importance", + "type": "str | None", + "description": "The importance level for the event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Source of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus", + "type": "float | str | None", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous", + "type": "float | str | None", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revised", + "type": "float | str | None", + "description": "Revised previous value, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "actual", + "type": "float | str | None", + "description": "Latest released value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "release_id", + "type": "int | None", + "description": "Release ID associated with the economic event.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FredEconomicCalendar", + "openapi_extra": { + "model": "FredEconomicCalendar" + } + }, + "/fred/economy/pce": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Personal Consumption Expenditures (PCE).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.pce(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + } + ], + "fred": [ + { + "name": "category", + "type": "str | None", + "description": "The category to query.", + "default": "personal_income", + "optional": true, + "choices": [ + "personal_income", + "wages_by_industry", + "real_pce_percent_change", + "real_pce_quantity_index", + "pce_price_index", + "pce_dollars", + "real_pce_chained_dollars", + "pce_price_percent_change" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "personal_income", + "wages_by_industry", + "real_pce_percent_change", + "real_pce_quantity_index", + "pce_price_index", + "pce_dollars", + "real_pce_chained_dollars", + "pce_price_percent_change" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredPersonalConsumptionExpenditures", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 0 + } + } + }, + { + "name": "symbol", + "type": "str", + "description": "The series id of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 1 + } + } + }, + { + "name": "value", + "type": "float", + "description": "The observed value.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 4 + } + } + }, + { + "name": "name", + "type": "str", + "description": "The name of the series.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 2 + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "The unit of measure the series is published in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 3 + } + } + }, + { + "name": "element_id", + "type": "str", + "description": "The element id in the parent/child relationship.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "parent_id", + "type": "str", + "description": "The parent id in the parent/child relationship.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "children", + "type": "str | None", + "description": "The element_id of each child, as a comma-separated string.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "level", + "type": "int", + "description": "The indentation level of the element.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "line", + "type": "int", + "description": "The line number of the series in the table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + } + ] + }, + "model": "FredPersonalConsumptionExpenditures", + "openapi_extra": { + "model": "FredPersonalConsumptionExpenditures" + } + }, + "/fred/economy/retail_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Retail prices for common items.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.retail_prices(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "item", + "type": "str | None", + "description": "The item or basket of items to query.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": false, + "choices": [ + "beverages", + "cereals", + "dairy", + "fuel", + "meats", + "produce", + "bacon", + "bananas", + "beans", + "beef", + "beer", + "bread", + "butter", + "cheese", + "chicken", + "chops", + "coffee", + "cookies", + "corn", + "diesel", + "eggs", + "electricity", + "flour", + "gas", + "gasoline", + "grapefruit", + "groud_beef", + "ham", + "ice_cream", + "lemons", + "lettuce", + "malt_beverages", + "milk", + "oil", + "orange_juice", + "oranges", + "potato_chips", + "potatoes", + "pork", + "rice", + "soft_drinks", + "spaghetti", + "steak", + "strawberries", + "sugar", + "tomatoes", + "unleaded", + "usda", + "vodka", + "wine", + "yogurt" + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "The country to get data.", + "default": "united_states", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": false, + "choices": [ + "united_states" + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "item", + "type": "str | None", + "description": "The item or basket of items to query.", + "default": "fuel", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country to get data.", + "default": "united_states", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "The region to get average price levels for.", + "default": "all_city", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredRetailPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the item.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Price, or change in price, per unit.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredRetailPrices", + "openapi_extra": { + "model": "FredRetailPrices" + } + }, + "/fred/economy/fred_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for FRED series or economic releases by ID or string.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.fred_search(query='gdp', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "The search word(s).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "search_type", + "type": "str | None", + "description": "The type of search to perform. Automatically set to 'release' when a 'release_id' is provided.", + "default": "full_text", + "optional": true, + "choices": [ + "full_text", + "series_id", + "release" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "release_id", + "type": "int | None", + "description": "A specific release ID to target.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. (1-1000)", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "order_by", + "type": "str | None", + "description": "Order the results by a specific attribute. The default is 'observation_end'.", + "default": "observation_end", + "optional": true, + "choices": [ + "search_rank", + "series_id", + "title", + "units", + "frequency", + "seasonal_adjustment", + "realtime_start", + "realtime_end", + "last_updated", + "observation_start", + "observation_end", + "popularity", + "group_popularity" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort_order", + "type": "str | None", + "description": "Sort the 'order_by' item in ascending or descending order. The default is 'desc'.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "filter_variable", + "type": "str | None", + "description": "Filter by an attribute.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "filter_value", + "type": "str | None", + "description": "String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "tag_names", + "type": "str | None | list[str | None]", + "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "exclude_tag_names", + "type": "str | None | list[str | None]", + "description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. This parameter is ignored when search_type is 'release'. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str | None", + "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "release_id", + "type": "str | None", + "description": "The release ID for queries.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str | None", + "description": "The series ID for the item in the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_group", + "type": "str | None", + "description": "The series group ID of the series. This value is used to query for regional data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region_type", + "type": "str | None", + "description": "The region type of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "The title of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "observation_start", + "type": "date | None", + "description": "The date of the first observation in the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "observation_end", + "type": "date | None", + "description": "The date of the last observation in the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency_short", + "type": "str | None", + "description": "Short form of the data frequency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "str | None", + "description": "The units of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units_short", + "type": "str | None", + "description": "Short form of the data units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seasonal_adjustment", + "type": "str | None", + "description": "The seasonal adjustment of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seasonal_adjustment_short", + "type": "str | None", + "description": "Short form of the data seasonal adjustment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_updated", + "type": "datetime | None", + "description": "The datetime of the last update to the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "popularity", + "type": "int | None", + "description": "Popularity of the series", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "group_popularity", + "type": "int | None", + "description": "Group popularity of the release", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "realtime_start", + "type": "date | None", + "description": "The realtime start date of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "realtime_end", + "type": "date | None", + "description": "The realtime end date of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "notes", + "type": "str | None", + "description": "Description of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "press_release", + "type": "bool | None", + "description": "If the release is a press release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "URL to the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredSearch", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "series_id", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "FredSearch" + } + }, + "/fred/economy/fred_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data by series ID from FRED.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.fred_series(symbol='GDP', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": "eop", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredSeries", + "openapi_extra": { + "model": "FredSeries" + } + }, + "/fred/economy/fred_release_table": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get economic release data by ID and/or element from FRED.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.fred_release_table(release_id='50', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "release_id", + "type": "str", + "description": "The ID of the release. Use `fred_search` to find releases.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "element_id", + "type": "str | None", + "description": "The element ID of a specific table in the release.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. Multiple items allowed for provider(s): fred.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredReleaseTable", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level", + "type": "int | None", + "description": "The indentation level of the element.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "element_type", + "type": "str | None", + "description": "The type of the element.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "line", + "type": "int | None", + "description": "The line number of the element.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "element_id", + "type": "str | None", + "description": "The element id in the parent/child relationship.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_id", + "type": "str | None", + "description": "The parent id in the parent/child relationship.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "children", + "type": "str | None", + "description": "The element_id of each child, as a comma-separated string.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The reported value of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the observation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 0 + } + } + }, + { + "name": "level", + "type": "int | None", + "description": "The indentation level of the element.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "element_type", + "type": "str | None", + "description": "The type of the element.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "line", + "type": "int | None", + "description": "The line number of the series in the table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "element_id", + "type": "str | None", + "description": "The element id in the parent/child relationship.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "parent_id", + "type": "str | None", + "description": "The parent id in the parent/child relationship.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "children", + "type": "str | None", + "description": "The element_id of each child, as a comma-separated string.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "symbol", + "type": "str | None", + "description": "The series id of the observation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 1 + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the series.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 2 + } + } + }, + { + "name": "value", + "type": "float | None", + "description": "The observed value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 4 + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "The unit of measure the series is published in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 3 + } + } + } + ] + }, + "model": "FredReleaseTable", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "FredReleaseTable" + } + }, + "/fred/economy/fred_regional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Query the Geo Federal Reserve Economic Data (GeoFRED) Regional Data API.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.fred_regional(symbol='NYUR', provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 100000, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "symbol", + "type": "str", + "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_series_group", + "type": "bool | None", + "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "region_type", + "type": "str | None", + "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", + "default": null, + "optional": true, + "choices": [ + "bea", + "msa", + "frb", + "necta", + "state", + "country", + "county", + "censusregion" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "bea", + "msa", + "frb", + "necta", + "state", + "country", + "county", + "censusregion" + ] + } + }, + { + "name": "season", + "type": "str | None", + "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", + "default": "nsa", + "optional": true, + "choices": [ + "sa", + "nsa", + "ssa" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "sa", + "nsa", + "ssa" + ] + } + }, + { + "name": "units", + "type": "str | None", + "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert high frequency data to lower frequency.\n \n None = No change\n \n a = Annual\n \n q = Quarterly\n \n m = Monthly\n \n w = Weekly\n \n d = Daily\n \n wef = Weekly, Ending Friday\n \n weth = Weekly, Ending Thursday\n \n wew = Weekly, Ending Wednesday\n \n wetu = Weekly, Ending Tuesday\n \n wem = Weekly, Ending Monday\n \n wesu = Weekly, Ending Sunday\n \n wesa = Weekly, Ending Saturday\n \n bwew = Biweekly, Ending Wednesday\n \n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", + "default": "eop", + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredRegional", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "region", + "type": "str", + "description": "The name of the region.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "code", + "type": "int | str", + "description": "The code of the region.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "The observation value. The units are defined in the search results by series ID.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str", + "description": "The individual series ID for the region.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FredRegional", + "openapi_extra": { + "model": "FredRegional" + } + }, + "/fred/fixedincome/bond_indices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Bond Indices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.bond_indices(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "index_type", + "type": "str | None", + "description": "The type of series. OAS is the option-adjusted spread. Default is yield.", + "default": "yield", + "optional": true, + "choices": [ + "yield", + "yield_to_worst", + "total_return", + "oas" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "yield", + "yield_to_worst", + "total_return", + "oas" + ] + } + } + ], + "fred": [ + { + "name": "category", + "type": "str | None", + "description": "The type of index category. Used in conjunction with 'index', default is 'us'.", + "default": "us", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "index", + "type": "str | None | list[str | None]", + "description": "The specific index to query. Used in conjunction with 'category' and 'index_type', default is 'yield_curve'.\n Possible values are:\n corporate\n seasoned_corporate\n liquid_corporate\n yield_curve\n crossover\n public_sector\n private_sector\n non_financial\n high_grade\n high_yield\n liquid_emea\n emea\n liquid_asia\n asia\n liquid_latam\n latam\n liquid_aaa\n liquid_bbb\n aaa\n aa\n a\n bbb\n bb\n b\n ccc Multiple items allowed.", + "default": "yield_curve", + "optional": true, + "choices": [ + "a", + "aa", + "aaa", + "asia", + "b", + "bb", + "bbb", + "ccc", + "corporate", + "crossover", + "emea", + "high_grade", + "high_yield", + "latam", + "liquid_aaa", + "liquid_asia", + "liquid_bbb", + "liquid_corporate", + "liquid_emea", + "liquid_latam", + "non_financial", + "private_sector", + "public_sector", + "seasoned_corporate", + "yield_curve" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set, default is 'avg'.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": "avg", + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredBondIndices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "us", + "type": "float | None", + "description": "High Yield Us.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Yield Us", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "europe", + "type": "float | None", + "description": "High Yield Europe.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Yield Europe", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "emerging", + "type": "float | None", + "description": "High Yield Emerging.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Yield Emerging", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "corporate", + "type": "float | None", + "description": "Emerging Markets Corporate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Corporate", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "seasoned_corporate", + "type": "float | None", + "description": "Us Seasoned Corporate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Us Seasoned Corporate", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "high_yield", + "type": "float | None", + "description": "Emerging Markets High Yield.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets High Yield", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "year1_year3", + "type": "float | None", + "description": "US Corporate year1_year3.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "US Corporate year1_year3", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "year3_year5", + "type": "float | None", + "description": "US Corporate year3_year5.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "US Corporate year3_year5", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "year5_year7", + "type": "float | None", + "description": "US Corporate year5_year7.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "US Corporate year5_year7", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "year7_year10", + "type": "float | None", + "description": "US Corporate year7_year10.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "US Corporate year7_year10", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "year10_year15", + "type": "float | None", + "description": "US Corporate year10_year15.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "US Corporate year10_year15", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "year15_plus", + "type": "float | None", + "description": "US Corporate year15+.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "US Corporate year15+", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "aaa", + "type": "float | None", + "description": "Emerging Markets Aaa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Aaa", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "aa", + "type": "float | None", + "description": "Us Aa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Us Aa", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "a", + "type": "float | None", + "description": "Us A.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Us A", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "bbb", + "type": "float | None", + "description": "Emerging Markets Bbb.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Bbb", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "bb", + "type": "float | None", + "description": "Emerging Markets Bb.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Bb", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "b", + "type": "float | None", + "description": "Emerging Markets B.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets B", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "ccc", + "type": "float | None", + "description": "Us Ccc.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Us Ccc", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "liquid_corporate", + "type": "float | None", + "description": "Emerging Markets Liquid Corporate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Liquid Corporate", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "crossover", + "type": "float | None", + "description": "Emerging Markets Crossover.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Crossover", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "public_sector", + "type": "float | None", + "description": "Emerging Markets Public Sector.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Public Sector", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "private_sector", + "type": "float | None", + "description": "Emerging Markets Private Sector.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Private Sector", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "non_financial", + "type": "float | None", + "description": "Emerging Markets Non Financial.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Non Financial", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "high_grade", + "type": "float | None", + "description": "Emerging Markets High Grade.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets High Grade", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "liquid_emea", + "type": "float | None", + "description": "Emerging Markets Liquid Emea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Liquid Emea", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "emea", + "type": "float | None", + "description": "Emerging Markets Emea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Emea", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "liquid_asia", + "type": "float | None", + "description": "Emerging Markets Liquid Asia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Liquid Asia", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "asia", + "type": "float | None", + "description": "Emerging Markets Asia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Asia", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "liquid_latam", + "type": "float | None", + "description": "Emerging Markets Liquid Latam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Liquid Latam", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "latam", + "type": "float | None", + "description": "Emerging Markets Latam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Latam", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "liquid_aaa", + "type": "float | None", + "description": "Emerging Markets Liquid Aaa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Liquid Aaa", + "cellDataType": "number", + "chartDataType": "series" + } + } + }, + { + "name": "liquid_bbb", + "type": "float | None", + "description": "Emerging Markets Liquid Bbb.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Emerging Markets Liquid Bbb", + "cellDataType": "number", + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredBondIndices", + "openapi_extra": { + "model": "FredBondIndices" + } + }, + "/fred/fixedincome/mortgage_indices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Mortgage Indices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.mortgage_indices(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "index", + "type": "str | None | list[str | None]", + "description": "The specific index, or index group, to query. Default is the 'primary' group. Multiple items allowed.", + "default": "primary", + "optional": true, + "choices": [ + "primary", + "ltv_lte_80", + "ltv_gt_80", + "conforming_30y", + "conforming_30y_na", + "jumbo_30y", + "fha_30y", + "va_30y", + "usda_30y", + "conforming_15y", + "ltv_lte80_fico_ge740", + "ltv_lte80_fico_a720b739", + "ltv_lte80_fico_a700b719", + "ltv_lte80_fico_a680b699", + "ltv_lte80_fico_lt680", + "ltv_gt80_fico_ge740", + "ltv_gt80_fico_a720b739", + "ltv_gt80_fico_a700b719", + "ltv_gt80_fico_a680b699", + "ltv_gt80_fico_lt680" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set, default is 'avg'.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": "avg", + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredMortgageIndices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "conforming_30y", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "conforming_30y_na", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming Non-Adjusted.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming Non-Adjusted", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "jumbo_30y", + "type": "float | None", + "description": "30-Year Fixed Rate Jumbo.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Jumbo", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "fha_30y", + "type": "float | None", + "description": "30-Year Fixed Rate FHA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate FHA", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "va_30y", + "type": "float | None", + "description": "30-Year Fixed Rate Veterans Affairs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Veterans Affairs", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "usda_30y", + "type": "float | None", + "description": "30-Year Fixed Rate USDA.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate USDA", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "conforming_15y", + "type": "float | None", + "description": "15-Year Fixed Rate Conforming.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "15-Year Fixed Rate Conforming", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_lte80_fico_ge740", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV <= 80 FICO >= 740.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV <= 80 FICO >= 740", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_lte80_fico_a720b739", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV <= 80 FICO 720-739.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV <= 80 FICO 720-739", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_lte80_fico_a700b719", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV <= 80 FICO 700-719.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV <= 80 FICO 700-719", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_lte80_fico_a680b699", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV <= 80 FICO 680-699.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV <= 80 FICO 680-699", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_lte80_fico_lt680", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV <= 80 FICO < 680.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV <= 80 FICO < 680", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_gt80_fico_ge740", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV > 80 FICO >= 740.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV > 80 FICO >= 740", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_gt80_fico_a720b739", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV > 80 FICO 720-739.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV > 80 FICO 720-739", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_gt80_fico_a700b719", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV > 80 FICO 700-719.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV > 80 FICO 700-719", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_gt80_fico_a680b699", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV > 80 FICO 680-699.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV > 80 FICO 680-699", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + }, + { + "name": "ltv_gt80_fico_lt680", + "type": "float | None", + "description": "30-Year Fixed Rate Conforming LTV > 80 FICO < 680.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "30-Year Fixed Rate Conforming LTV > 80 FICO < 680", + "cellDataType": "number", + "chartDataType": "series" + }, + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FredMortgageIndices", + "openapi_extra": { + "model": "FredMortgageIndices" + } + }, + "/fred/fixedincome/government/tips_yields": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get current Treasury inflation-protected securities yields.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.government.tips_yields(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "maturity", + "type": "str | None", + "description": "The maturity of the security in years - 10, 20, 30 - defaults to all. Note that the maturity is the tenor of the security, not the time to maturity.", + "default": null, + "optional": true, + "choices": [ + "10", + "20", + "30" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "10", + "20", + "30" + ] + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredTipsYields", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "due", + "type": "date | None", + "description": "The due date (maturation date) of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The yield value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "due", + "type": "date | None", + "description": "The due date (maturation date) of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "value", + "type": "float | None", + "description": "The yield value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "cellDataType": "number", + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredTipsYields", + "openapi_extra": { + "model": "FredTipsYields" + } + }, + "/fred/fixedincome/government/yield_curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get yield curve data by country and date.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.government.yield_curve(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. By default is the current data. Multiple items allowed for provider(s): fred.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + } + ], + "fred": [ + { + "name": "yield_curve_type", + "type": "str | None", + "description": "Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned.", + "default": "nominal", + "optional": true, + "choices": [ + "nominal", + "real", + "breakeven", + "treasury_minus_fed_funds", + "corporate_spot", + "corporate_par" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "nominal", + "real", + "breakeven", + "treasury_minus_fed_funds", + "corporate_spot", + "corporate_par" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredYieldCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the security.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "rate", + "type": "float | None", + "description": "The yield of the security at the given maturity, as published by FRED.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredYieldCurve", + "openapi_extra": { + "model": "FredYieldCurve" + } + }, + "/fred/fixedincome/rate/ameribor": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Ameribor.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.ameribor(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "maturity", + "type": "str | None | list[str | None]", + "description": "Period of AMERIBOR rate. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredAmeribor", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the item.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Interest rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "title", + "type": "str | None", + "description": "Title of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "category" + } + } + }, + { + "name": "maturity", + "type": "str", + "description": "Maturity length of the item.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Interest rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "title", + "type": "str | None", + "description": "Title of the series.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "FredAmeribor", + "openapi_extra": { + "model": "FredAmeribor" + } + }, + "/fred/fixedincome/rate/dpcredit": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Discount Window Primary Credit Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.dpcredit(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "parameter", + "type": "str | None", + "description": "FRED series ID of DWPCR data.", + "default": "daily_excl_weekend", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredDiscountWindowPrimaryCreditRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Discount Window Primary Credit Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredDiscountWindowPrimaryCreditRate", + "openapi_extra": { + "model": "FredDiscountWindowPrimaryCreditRate" + } + }, + "/fred/fixedincome/rate/estr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Euro Short-Term Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.estr(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n \n a = Annual\n \n q = Quarterly\n \n m = Monthly\n \n w = Weekly\n \n d = Daily\n \n wef = Weekly, Ending Friday\n \n weth = Weekly, Ending Thursday\n \n wew = Weekly, Ending Wednesday\n \n wetu = Weekly, Ending Tuesday\n \n wem = Weekly, Ending Monday\n \n wesu = Weekly, Ending Sunday\n \n wesa = Weekly, Ending Saturday\n \n bwew = Biweekly, Ending Wednesday\n \n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredEuroShortTermRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Volume-weighted trimmed mean rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "Rate at 25th percentile of volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "Rate at 75th percentile of volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume. (Millions of \u20acEUR).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000.0 + } + }, + { + "name": "transactions", + "type": "int | None", + "description": "Number of transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_banks", + "type": "int | None", + "description": "Number of active banks.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "large_bank_share_of_volume", + "type": "float | None", + "description": "The percent of volume attributable to the 5 largest active banks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Volume-weighted trimmed mean rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "Rate at 25th percentile of volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "Rate at 75th percentile of volume.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume. (Millions of \u20acEUR).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000.0, + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "transactions", + "type": "int | None", + "description": "Number of transactions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "number_of_banks", + "type": "int | None", + "description": "Number of active banks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + }, + { + "name": "large_bank_share_of_volume", + "type": "float | None", + "description": "The percent of volume attributable to the 5 largest active banks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "FredEuroShortTermRate", + "openapi_extra": { + "model": "FredEuroShortTermRate" + } + }, + "/fred/fixedincome/rate/ecb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "European Central Bank Interest Rates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.ecb(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interest_rate_type", + "type": "str | None", + "description": "The type of interest rate.", + "default": "lending", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredEuropeanCentralBankInterestRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "European Central Bank Interest Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredEuropeanCentralBankInterestRates", + "openapi_extra": { + "model": "FredEuropeanCentralBankInterestRates" + } + }, + "/fred/fixedincome/rate/effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fed Funds Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.effr(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "effr_only", + "type": "bool | None", + "description": "Return data without quantiles, target ranges, and volume.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredFederalFundsRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Effective federal funds rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "target_range_upper", + "type": "float | None", + "description": "Upper bound of the target range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "target_range_lower", + "type": "float | None", + "description": "Lower bound of the target range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Effective federal funds rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "target_range_upper", + "type": "float | None", + "description": "Upper bound of the target range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "target_range_lower", + "type": "float | None", + "description": "Lower bound of the target range.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "FredFederalFundsRate", + "openapi_extra": { + "model": "FredFederalFundsRate" + } + }, + "/fred/fixedincome/rate/iorb": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Interest on Reserve Balances.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.iorb(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredIORB", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "IORB rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "IORB rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredIORB", + "openapi_extra": { + "model": "FredIORB" + } + }, + "/fred/fixedincome/rate/overnight_bank_funding": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Overnight Bank Funding.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.overnight_bank_funding(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredOvernightBankFundingRate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Overnight Bank Funding Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Overnight Bank Funding Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B", + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "FredOvernightBankFundingRate", + "openapi_extra": { + "model": "FredOvernightBankFundingRate" + } + }, + "/fred/fixedincome/rate/effr_forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fed Funds Rate Projections.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.effr_forecast(provider='fred')\n```\n\n", + "parameters": { + "standard": [], + "fred": [ + { + "name": "long_run", + "type": "bool | None", + "description": "Flag to show long run projections", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredPROJECTIONS", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "range_high", + "type": "float", + "description": "High projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "central_tendency_high", + "type": "float", + "description": "Central tendency of high projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "median", + "type": "float", + "description": "Median projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "range_midpoint", + "type": "float", + "description": "Midpoint projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "central_tendency_midpoint", + "type": "float", + "description": "Central tendency of midpoint projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "range_low", + "type": "float", + "description": "Low projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "central_tendency_low", + "type": "float", + "description": "Central tendency of low projection of rates.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredPROJECTIONS", + "openapi_extra": { + "model": "FredPROJECTIONS" + } + }, + "/fred/fixedincome/rate/sofr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Secured Overnight Financing Rate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.sofr(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", + "default": null, + "optional": true, + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "a", + "q", + "m", + "w", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSOFR", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Effective federal funds rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B" + } + } + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Effective federal funds rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_1", + "type": "float | None", + "description": "1st percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_25", + "type": "float | None", + "description": "25th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_75", + "type": "float | None", + "description": "75th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "percentile_99", + "type": "float | None", + "description": "99th percentile of the distribution.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.The notional volume of transactions (Billions of $).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency", + "x-frontend_multiply": 1000000000.0, + "x-widget_config": { + "prefix": "$", + "suffix": "B", + "chartDataType": "excluded" + } + } + }, + { + "name": "average_30d", + "type": "float | None", + "description": "30-Day Average SOFR", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "average_90d", + "type": "float | None", + "description": "90-Day Average SOFR", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "average_180d", + "type": "float | None", + "description": "180-Day Average SOFR", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + }, + { + "name": "index", + "type": "float | None", + "description": "SOFR index as 2018-04-02 = 1", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "excluded" + } + } + } + ] + }, + "model": "FredSOFR", + "openapi_extra": { + "model": "FredSOFR" + } + }, + "/fred/fixedincome/rate/sonia": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sterling Overnight Index Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.rate.sonia(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "parameter", + "type": "str | None", + "description": "Period of SONIA rate.", + "default": "rate", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSONIA", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "SONIA rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredSONIA", + "openapi_extra": { + "model": "FredSONIA" + } + }, + "/fred/fixedincome/spreads/treasury_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Bill.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.spreads.treasury_effr(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str | None", + "description": "The maturity", + "default": "3m", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSelectedTreasuryBill", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "SelectedTreasuryBill Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredSelectedTreasuryBill", + "openapi_extra": { + "model": "FredSelectedTreasuryBill" + } + }, + "/fred/fixedincome/spreads/tcm_effr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Select Treasury Constant Maturity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.spreads.tcm_effr(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str | None", + "description": "The maturity", + "default": "10y", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSelectedTreasuryConstantMaturity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "Selected Treasury Constant Maturity Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredSelectedTreasuryConstantMaturity", + "openapi_extra": { + "model": "FredSelectedTreasuryConstantMaturity" + } + }, + "/fred/fixedincome/spreads/tcm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Treasury Constant Maturity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.fixedincome.spreads.tcm(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str | None", + "description": "The maturity", + "default": "3m", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredTreasuryConstantMaturity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "chartDataType": "time" + } + } + }, + { + "name": "rate", + "type": "float", + "description": "TreasuryConstantMaturity Rate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-widget_config": { + "chartDataType": "series" + } + } + } + ] + }, + "model": "FredTreasuryConstantMaturity", + "openapi_extra": { + "model": "FredTreasuryConstantMaturity" + } + }, + "/fred/economy/survey/manufacturing_outlook_ny": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Empire State Manufacturing Survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.survey.manufacturing_outlook_ny(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "topic", + "type": "str | None | list[str | None]", + "description": "The topic for the survey response. Multiple items allowed.", + "default": "new_orders", + "optional": true, + "choices": [ + "business_outlook", + "hours_worked", + "employment", + "inventories", + "prices_received", + "prices_paid", + "capex", + "unfilled_orders", + "new_orders", + "shipments", + "delivery_times" + ], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "value": "new_orders" + } + } + }, + { + "name": "seasonally_adjusted", + "type": "bool | None", + "description": "Whether the data is seasonally adjusted, default is False", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredManufacturingOutlookNY", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "topic", + "type": "str | None", + "description": "Topic of the survey response.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diffusion_index", + "type": "float | None", + "description": "Diffusion Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_reporting_increase", + "type": "float | None", + "description": "Percent of respondents reporting an increase over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percent_reporting_decrease", + "type": "float | None", + "description": "Percent of respondents reporting a decrease over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percent_reporting_no_change", + "type": "float | None", + "description": "Percent of respondents reporting no change over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "fred": [ + { + "name": "percent_reporting_increase", + "type": "float | None", + "description": "Percent of respondents reporting an increase over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "percent_reporting_decrease", + "type": "float | None", + "description": "Percent of respondents reporting a decrease over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "percent_reporting_no_change", + "type": "float | None", + "description": "Percent of respondents reporting no change over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FredManufacturingOutlookNY", + "openapi_extra": { + "model": "FredManufacturingOutlookNY" + } + }, + "/fred/economy/survey/manufacturing_outlook_texas": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Texas Manufacturing Outlook Survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.survey.manufacturing_outlook_texas(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "topic", + "type": "str | None | list[str | None]", + "description": "The topic for the survey response. Multiple items allowed.", + "default": "new_orders_growth", + "optional": true, + "choices": [ + "business_activity", + "business_outlook", + "capex", + "prices_paid", + "production", + "inventory", + "new_orders", + "new_orders_growth", + "unfilled_orders", + "shipments", + "delivery_time", + "employment", + "wages", + "hours_worked" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", + "default": null, + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "annual", + "quarter" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredManufacturingOutlookTexas", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "topic", + "type": "str | None", + "description": "Topic of the survey response.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diffusion_index", + "type": "float | None", + "description": "Diffusion Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_reporting_increase", + "type": "float | None", + "description": "Percent of respondents reporting an increase over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percent_reporting_decrease", + "type": "float | None", + "description": "Percent of respondents reporting a decrease over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "percent_reporting_no_change", + "type": "float | None", + "description": "Percent of respondents reporting no change over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "fred": [ + { + "name": "percent_reporting_increase", + "type": "float | None", + "description": "Percent of respondents reporting an increase over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "percent_reporting_decrease", + "type": "float | None", + "description": "Percent of respondents reporting a decrease over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + }, + { + "name": "percent_reporting_no_change", + "type": "float | None", + "description": "Percent of respondents reporting no change over the last month.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FredManufacturingOutlookTexas", + "openapi_extra": { + "model": "FredManufacturingOutlookTexas" + } + }, + "/fred/economy/survey/nonfarm_payrolls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Nonfarm Payrolls Survey.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.survey.nonfarm_payrolls(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "fred": { + "multiple_items_allowed": true + } + } + } + ], + "fred": [ + { + "name": "category", + "type": "str | None", + "description": "The category to query.", + "default": "employees_nsa", + "optional": true, + "choices": [ + "employees_nsa", + "employees_sa", + "employees_production_and_nonsupervisory", + "employees_women", + "employees_women_percent", + "avg_hours", + "avg_hours_production_and_nonsupervisory", + "avg_hours_overtime", + "avg_hours_overtime_production_and_nonsupervisory", + "avg_earnings_hourly", + "avg_earnings_hourly_production_and_nonsupervisory", + "avg_earnings_weekly", + "avg_earnings_weekly_production_and_nonsupervisory", + "index_weekly_hours", + "index_weekly_hours_production_and_nonsupervisory", + "index_weekly_payrolls", + "index_weekly_payrolls_production_and_nonsupervisory" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "employees_nsa", + "employees_sa", + "employees_production_and_nonsupervisory", + "employees_women", + "employees_women_percent", + "avg_hours", + "avg_hours_production_and_nonsupervisory", + "avg_hours_overtime", + "avg_hours_overtime_production_and_nonsupervisory", + "avg_earnings_hourly", + "avg_earnings_hourly_production_and_nonsupervisory", + "avg_earnings_weekly", + "avg_earnings_weekly_production_and_nonsupervisory", + "index_weekly_hours", + "index_weekly_hours_production_and_nonsupervisory", + "index_weekly_payrolls", + "index_weekly_payrolls_production_and_nonsupervisory" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredNonFarmPayrolls", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 0 + } + } + }, + { + "name": "symbol", + "type": "str", + "description": "The series id of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 1 + } + } + }, + { + "name": "value", + "type": "float", + "description": "The observed value.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 4 + } + } + }, + { + "name": "name", + "type": "str", + "description": "The name of the series.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 2 + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "The unit of measure the series is published in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerIndex": 3 + } + } + }, + { + "name": "element_id", + "type": "str", + "description": "The element id in the parent/child relationship.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "parent_id", + "type": "str", + "description": "The parent id in the parent/child relationship.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "children", + "type": "str | None", + "description": "The element_id of each child, as a comma-separated string.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + }, + { + "name": "level", + "type": "int", + "description": "The indentation level of the element.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true, + "cellDataType": "text", + "formatterFn": "none" + } + } + } + ] + }, + "model": "FredNonFarmPayrolls", + "openapi_extra": { + "model": "FredNonFarmPayrolls" + } + }, + "/fred/economy/survey/sloos": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Senior Loan Officer Opinion Survey on Bank Lending Practices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.survey.sloos(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "category", + "type": "str | None", + "description": "Category of survey response.", + "default": "spreads", + "optional": true, + "choices": [ + "spreads", + "consumer", + "auto", + "credit_card", + "firms", + "mortgage", + "commercial_real_estate", + "standards", + "demand", + "foreign_banks" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "spreads", + "consumer", + "auto", + "credit_card", + "firms", + "mortgage", + "commercial_real_estate", + "standards", + "demand", + "foreign_banks" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSeniorLoanOfficerSurvey", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "Survey value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Survey title.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredSeniorLoanOfficerSurvey", + "openapi_extra": { + "model": "FredSeniorLoanOfficerSurvey" + } + }, + "/fred/economy/survey/economic_conditions_chicago": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Survey of Economic Conditions - Chicago Fed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.survey.economic_conditions_chicago(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", + "default": null, + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "annual", + "quarter" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredSurveyOfEconomicConditionsChicago", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "activity_index", + "type": "float | None", + "description": "Activity Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "one_year_outlook", + "type": "float | None", + "description": "One Year Outlook Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "manufacturing_activity", + "type": "float | None", + "description": "Manufacturing Activity Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_manufacturing_activity", + "type": "float | None", + "description": "Non-Manufacturing Activity Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_expenditures_expectations", + "type": "float | None", + "description": "Capital Expenditures Expectations Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hiring_expectations", + "type": "float | None", + "description": "Hiring Expectations Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_hiring", + "type": "float | None", + "description": "Current Hiring Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "labor_costs", + "type": "float | None", + "description": "Labor Costs Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_labor_costs", + "type": "float | None", + "description": "Non-Labor Costs Index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "fred": [] + }, + "model": "FredSurveyOfEconomicConditionsChicago", + "openapi_extra": { + "model": "FredSurveyOfEconomicConditionsChicago" + } + }, + "/fred/economy/survey/university_of_michigan": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get University of Michigan Consumer Sentiment and Inflation Expectations Surveys.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.fred.economy.survey.university_of_michigan(provider='fred')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "fred": [ + { + "name": "frequency", + "type": "str | None", + "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", + "default": null, + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "annual", + "quarter" + ] + } + }, + { + "name": "aggregation_method", + "type": "str | None", + "description": "A key that indicates the aggregation method used for frequency aggregation.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", + "default": null, + "optional": true, + "choices": [ + "avg", + "sum", + "eop" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "avg", + "sum", + "eop" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", + "default": null, + "optional": true, + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ] + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the request is served from, and written to, the FRED response cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FredUniversityOfMichigan", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "consumer_sentiment", + "type": "float | None", + "description": "Index of the results of the University of Michigan's monthly Survey of Consumers, which is used to estimate future spending and saving. (1966:Q1=100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inflation_expectation", + "type": "float | None", + "description": "Median expected price change next 12 months, Surveys of Consumers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "fred": [ + { + "name": "inflation_expectation", + "type": "float | None", + "description": "Median expected price change next 12 months, Surveys of Consumers.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent" + } + } + ] + }, + "model": "FredUniversityOfMichigan", + "openapi_extra": { + "model": "FredUniversityOfMichigan" + } + }, + "/imf/list_dataflows": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List all available IMF dataflows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Lists all known dataflows available from the IMF in JSON format.\nobb.imf.list_dataflows(output_format='json')\n# Return the content as a markdown-formatted summary instead of a JSON table.\nobb.imf.list_dataflows(output_format='markdown')\n# Lists all known dataflows available from the IMF.\nimf_dataflows = obb.imf.list_dataflows()\nprint(imf_dataflows)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "output_format", + "type": "str", + "description": "", + "default": "json", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "description": "Descriptions for all IMF dataflows.", + "params": [ + { + "paramName": "output_format", + "label": "Output Format", + "value": "markdown", + "description": "Output format: 'json' or 'markdown'.", + "show": false + } + ], + "type": "markdown", + "data": { + "dataKey": "results" + }, + "gridData": { + "w": 40, + "h": 15 + }, + "refetchInterval": false, + "name": "IMF Dataflows", + "source": [ + "IMF" + ], + "category": "IMF Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/imf/get_dataflow_dimensions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Dataflow parameters and their possible values.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get parameters for the 'CPI' dataflow.\nimf_params = obb.imf.get_dataflow_dimensions('CPI')\nprint(imf_params.results)\n# Get parameters for the 'GFS_BS' dataflow in markdown format.\nobb.imf.get_dataflow_dimensions(dataflow_id='GFS_BS', output_format='markdown')\n# Get parameters for the 'IL' dataflow in JSON format.\nobb.imf.get_dataflow_dimensions(dataflow_id='IL', output_format='json')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataflow_id", + "type": "str", + "description": "The IMF dataflow ID. Use `list_dataflows()` to see available dataflows.", + "default": null, + "optional": false + }, + { + "name": "output_format", + "type": "str", + "description": "", + "default": "json", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "IMF Dataflow Parameters", + "type": "markdown", + "params": [ + { + "paramName": "dataflow_id", + "label": "Dataflow", + "value": "CPI", + "description": "The IMF dataflow to display.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/list_dataflow_choices", + "style": { + "popupWidth": 700 + } + }, + { + "paramName": "output_format", + "value": "markdown", + "show": false + } + ], + "source": [ + "IMF" + ], + "category": "IMF Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/imf/list_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the list of presentation tables available from the IMF.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the list of available presentation tables.\nobb.imf.list_tables()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ImfTableMetadata]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "name", + "type": "str", + "description": "The name of the IMF table.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "The table symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str", + "description": "Description of the IMF table.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "agency_id", + "type": "str", + "description": "The agency ID responsible for the table.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dataflow_id", + "type": "str", + "description": "The IMF dataflow ID the table belongs to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "codelist_id", + "type": "str", + "description": "The codelist ID associated with the table.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "IMF Presentation Tables List", + "description": "Presentation tables from the IMF database.", + "params": [ + { + "paramName": "symbol", + "label": "Table Symbol", + "value": null, + "description": "Dummy parameter to allow grouping in the UI.", + "type": "text", + "show": false + } + ], + "refetchInterval": false, + "source": [ + "IMF" + ], + "category": "IMF Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/imf/list_table_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get presentation table choices for IMF data retrieval.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get presentation table choices for IMF data retrieval.\n >>> obb.imf.list_table_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get presentation table choices for IMF data retrieval.\nobb.imf.list_table_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/list_dataflow_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get dataflow choices for IMF data retrieval.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get dataflow choices for IMF data retrieval.\n >>> obb.imf.list_dataflow_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get dataflow choices for IMF data retrieval.\nobb.imf.list_dataflow_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/list_bop_country_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get country choices (label, ISO3 value) for the IMF Balance of Payments dataflow.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get country choices for the IMF Balance of Payments dataflow.\n >>> obb.imf.list_bop_country_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get country choices for the IMF Balance of Payments dataflow.\nobb.imf.list_bop_country_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/list_cpi_country_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get country choices (label, ISO3 value) for the IMF Consumer Price Index dataflow.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get country choices for the IMF Consumer Price Index dataflow.\n >>> obb.imf.list_cpi_country_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get country choices for the IMF Consumer Price Index dataflow.\nobb.imf.list_cpi_country_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/presentation_table_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get presentation table choices for IMF data retrieval.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the dataflow group choices.\nobb.imf.presentation_table_choices()\n# Get table choices for the 'cpi' dataflow group.\nobb.imf.presentation_table_choices(dataflow_group='cpi')\n# Get country choices for the 'cpi' dataflow group and 'cpi' table.\nobb.imf.presentation_table_choices(dataflow_group='cpi', table='cpi')\n# Get frequency choices for the 'cpi' dataflow group, 'cpi' table, and 'JPN' country.\nobb.imf.presentation_table_choices(dataflow_group='cpi', table='cpi', country='JPN')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataflow_group", + "type": "str", + "description": "The IMF dataflow group. Show all groups if None.", + "default": null, + "optional": true + }, + { + "name": "table", + "type": "str", + "description": "The IMF presentation table ID. Enter a dataflow_group to see table choices.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Enter a dataflow_group and table to see country choices.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "Enter a dataflow_group, table, and country to see frequency choices.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/presentation_table": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a presentation table from the IMF database as native AG Grid rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the most recent Balance of Payments table for Japan.\nobb.imf.presentation_table(dataflow_group='bop', table='bop_standard', country='JPN', frequency='Q', limit=4)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataflow_group", + "type": "str", + "description": "The IMF dataflow group. See presentation_table_choices() for options.", + "default": null, + "optional": true + }, + { + "name": "table", + "type": "str", + "description": "The IMF presentation table ID. See presentation_table_choices() for options.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country code to filter the data. Enter multiple codes by joining on '+'. See presentation_table_choices() for options. Typical values are ISO3 country codes.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "The data frequency. See presentation_table_choices() for options. Typical values are 'A' (annual), 'Q' (quarter), 'M' (month), or 'D' (day).", + "default": null, + "optional": true + }, + { + "name": "dimension_values", + "type": "list[str] | str", + "description": "Dimension selection for filtering. Format: 'DIM_ID1:VAL1+VAL2.' See presentation_table_choices() and list_dataflow_choices() for available dimensions and values.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Maximum number of records to retrieve per series.", + "default": 1, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "dataflow_group", + "label": "Dataflow", + "value": null, + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/presentation_table_choices", + "description": "The IMF dataflow group." + }, + { + "paramName": "table", + "label": "Table", + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/presentation_table_choices", + "optionsParams": { + "dataflow_group": "$dataflow_group" + }, + "description": "The IMF presentation table." + }, + { + "paramName": "country", + "label": "Country", + "description": "Country or region for the table.", + "type": "endpoint", + "multiSelect": false, + "optionsEndpoint": "/api/v1/imf/presentation_table_choices", + "optionsParams": { + "dataflow_group": "$dataflow_group", + "table": "$table", + "dimension_values": "$dimension_values" + } + }, + { + "paramName": "frequency", + "label": "Frequency", + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/presentation_table_choices", + "optionsParams": { + "dataflow_group": "$dataflow_group", + "table": "$table", + "country": "$country", + "dimension_values": "$dimension_values" + }, + "description": "The data frequency." + }, + { + "paramName": "dimension_values", + "label": "Dimension Values", + "type": "text", + "value": null, + "description": "Dimension selection for filtering. Format: 'DIM_ID1:VAL1+VAL2.'", + "multiple": true, + "multiSelect": false + }, + { + "paramName": "limit", + "label": "Limit", + "value": 3, + "description": "Most recent N records to retrieve per series.", + "type": "number" + } + ], + "runButton": true, + "refetchInterval": false, + "name": "IMF Presentation Table", + "description": "Presentation tables from the IMF database.", + "source": [ + "IMF" + ], + "category": "IMF Data", + "subCategory": "Presentation Tables" + }, + "model": "" + } + }, + "/imf/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the IMF SDMX indicator catalog by query, dataflow, or keyword.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the full IMF indicator catalog.\nobb.imf.available_indicators(provider='imf')\n# Filter the catalog to specific dataflows.\nobb.imf.available_indicators(provider='imf', dataflows='CPI,PCPS')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "query", + "type": "str | None | list[str | None]", + "description": "The search query string. Multiple search phrases can be separated by semicolons. Each phrase can use AND (+) and OR (|) operators, as well as quoted phrases. Semicolon separation allows commas to be used within search phrases. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "dataflows", + "type": "list[str] | str | None | list[list[str] | str | None]", + "description": "List of IMF dataflow IDs to filter the indicators. Use semicolons to separate multiple dataflow IDs. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/list_dataflow_choices", + "multiSelect": false, + "style": { + "popupWidth": 950 + } + } + } + }, + { + "name": "keywords", + "type": "list[str] | str | None | list[list[str] | str | None]", + "description": "List of keywords to filter results. Each keyword is a single word that must appear in the indicator's label or description. Keywords prefixed with 'not' will exclude indicators containing that word (e.g., 'not USD' excludes indicators with 'USD' in them). Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Dummy field to allow grouping by symbol. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "multiSelect": false, + "style": { + "width": 400 + }, + "multiple": true + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AvailableImfIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol_root", + "type": "str | None", + "description": "The root symbol representing the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The name of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "iso", + "type": "str | None", + "description": "The ISO code of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The description of the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the indicator data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "agency_id", + "type": "str", + "description": "The agency ID responsible for the indicator.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dataflow_id", + "type": "str", + "description": "The IMF dataflow ID associated with the indicator.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dataflow_name", + "type": "str", + "description": "The name of the IMF dataflow (symbol root).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "structure_id", + "type": "str", + "description": "The data structure ID associated with the indicator.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dimension_id", + "type": "str", + "description": "The dimension ID of the indicator in the data structure.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "long_description", + "type": "str | None", + "description": "Detailed description of the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "member_of", + "type": "list[str] | None", + "description": "List of table symbols (dataflow_id::table_id) this indicator belongs to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "extra_dimensions", + "type": "list[str] | None", + "description": "Non-standard dimensions the dataflow exposes beyond country / frequency / indicator / transform. Pass each as ``DIM_ID:DIM_VALUE`` in the ``dimension_values`` parameter when calling ``obb.economy.indicators``.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "AvailableImfIndicators", + "openapi_extra": { + "model": "AvailableImfIndicators" + } + }, + "/imf/indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch IMF economic indicators or presentation tables by ``dataflow::code`` symbol.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fetch a single indicator series by ``dataflow::code`` symbol.\nobb.imf.indicators(provider='imf', symbol='IL::RGV_REVS', country='*', frequency='month', limit=1, start_date='2025-09-30')\n# Fetch a full presentation table for a country.\nobb.imf.indicators(provider='imf', symbol='DIP::H_DIP_INDICATOR', country='BRA', frequency='annual', limit=2, pivot=True)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): imf.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "multiple_items_allowed": true, + "x-widget_config": { + "label": "Indicator Symbol", + "multiSelect": false, + "multiple": false, + "type": "text" + } + } + } + }, + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): imf.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "multiple_items_allowed": true, + "x-widget_config": { + "label": "Country", + "description": "Country or region for the table.", + "type": "endpoint", + "multiSelect": true, + "multiple": false, + "optionsEndpoint": "/api/v1/imf/indicator_choices", + "optionsParams": { + "symbol": "$symbol", + "country": "true", + "dimension_values": "$dimension_values" + }, + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "x-widget_config": { + "label": "Frequency", + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/indicator_choices", + "optionsParams": { + "symbol": "$symbol", + "country": "$country", + "frequency": "true", + "dimension_values": "$dimension_values" + }, + "description": "The data frequency." + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. Symbol format: 'dataflow::identifier' where identifier is either:\n- A table ID (starts with 'H_') for hierarchical table data\n- An indicator code for individual indicator data\n\nExamples:\n - 'BOP::H_BOP_BOP_AGG_STANDARD_PRESENTATION' - Balance of Payments table\n - 'BOP_AGG::GS_CD,BOP_AGG::GS_DB' - Multiple BOP_AGG indicators (Goods & Services)\n - 'IL::RGV_REVS' - Gold reserves in millions of fine troy ounces\n - 'WEO::NGDP_RPCH' - Real GDP growth (annual only)\n - 'WEO::POILBRE' - Brent crude oil price (use country='G001' for world)\n - 'PCPS::PGOLD' - Gold price per troy ounce (monthly/quarterly available)\n\nUse `obb.economy.available_indicators(provider='imf')` to discover symbols. Use `obb.imf.list_tables()` to see available tables.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "ISO3 country code(s). Use comma-separated values for multiple countries. Validated against the dataflow's available countries via constraint API.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data. Choices vary by indicator and country. Common options: 'annual', 'quarter', 'month'. Use 'all' or '*' to return all available frequencies. Direct IMF codes (e.g., 'A', 'Q', 'M') are also accepted.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation to apply to the data. User-friendly options: 'index' (raw values), 'yoy' (year-over-year %), 'period' (period-over-period %). Use 'all' or '*' to return all available transformations. Direct IMF codes (e.g., 'USD', 'IX') are also accepted.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Transform", + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/indicator_choices", + "optionsParams": { + "symbol": "$symbol", + "country": "$country", + "frequency": "$frequency", + "transform": "true", + "dimension_values": "$dimension_values" + }, + "description": "Transformation to apply to the data.", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "dimension_values", + "type": "list[str] | None", + "description": "List of additional dimension filters in 'DIM_ID:DIM_VALUE' format. Parameter can be entered multiple times.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Dimension Filters", + "type": "text", + "value": null, + "description": "Additional dimension filters in 'DIM_ID:DIM_VALUE' format. See IMF Dataflow Parameters widget for all possible combinations.", + "multiple": true + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of records to retrieve per series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Limit", + "value": null, + "description": "Most recent N records to retrieve per series.", + "type": "number" + } + } + }, + { + "name": "pivot", + "type": "bool | None", + "description": "If True, pivots the data to presentation view with 'indicator' and 'country' as the index, date as values.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol_root", + "type": "str | None", + "description": "The root symbol for the indicator (e.g. GDP).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country represented by the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit_multiplier", + "type": "float | int | None", + "description": "The multiplier for the unit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "scale", + "type": "str | None", + "description": "The scale/multiplier of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "float | int | None", + "description": "Sort order within the table hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level", + "type": "int | None", + "description": "Indentation level in the table hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Human-readable title of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str | None", + "description": "ISO3 country code.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ImfIndicators", + "openapi_extra": { + "model": "ImfIndicators" + } + }, + "/imf/cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Consumer Price Index (CPI) data from the IMF.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Latest CPI basket weightings reported by the IMF.\nobb.imf.cpi(provider='imf', country='CAN', transform='weight_percent', expenditure='all', limit=1)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): imf.", + "default": "united_states", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/list_cpi_country_choices", + "value": [ + "USA" + ], + "style": { + "popupWidth": 400 + } + } + } + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation of the CPI data.", + "default": "yoy", + "optional": true, + "choices": [ + "index", + "period", + "yoy", + "ref_index", + "ref_period", + "ref_yoy", + "weight", + "weight_percent" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "multiple_items_allowed": false, + "choices": [ + "index", + "period", + "yoy", + "ref_index", + "ref_period", + "ref_yoy", + "weight", + "weight_percent" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "harmonized", + "type": "bool | None", + "description": "If true, returns harmonized data.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "country", + "type": "str | None", + "description": "The country (ISO3 code or label) to get data for.", + "default": "USA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expenditure", + "type": "str | None | list[str | None]", + "description": "Expenditure component of CPI. Multiple items allowed.", + "default": "total", + "optional": true, + "choices": [ + "total", + "all", + "food_non_alcoholic_beverages", + "alcoholic_beverages_tobacco_narcotics", + "clothing_footwear", + "housing_water_electricity_gas", + "furniture_household_equipment", + "health", + "transport", + "communication", + "recreation_culture", + "education", + "restaurants_hotels", + "miscellaneous_goods_services" + ], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "value": "total" + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of records to retrieve per series and country. If None, retrieves all available records.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfConsumerPriceIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "None", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "CPI index value or period change.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "unit", + "type": "str", + "description": "Unit of measurement.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit_multiplier", + "type": "float | int", + "description": "Unit multiplier for the observation value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str", + "description": "ISO3 country code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str", + "description": "IMF series identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "expenditure", + "type": "str", + "description": "Expenditure category.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Complete reference title for the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "int | None", + "description": "Sort order for expenditure categories and table presentations.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ImfConsumerPriceIndex", + "openapi_extra": { + "model": "ImfConsumerPriceIndex" + } + }, + "/imf/balance_of_payments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Balance of Payments reports from the IMF BOP dataflow.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.imf.balance_of_payments(provider='imf')\nobb.imf.balance_of_payments(provider='imf', country='BRA')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed.", + "default": "USA", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/list_bop_country_choices", + "value": [ + "USA" + ], + "style": { + "popupWidth": 400 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Reporting frequency.", + "default": "quarterly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfBalanceOfPayments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "date | None", + "description": "The date representing the beginning of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_percent_of_gdp", + "type": "float | None", + "description": "Current Account Balance as Percent of GDP", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "balance_total", + "type": "float | None", + "description": "Current Account Total Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_services", + "type": "float | None", + "description": "Current Account Total Services Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_secondary_income", + "type": "float | None", + "description": "Current Account Total Secondary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_goods", + "type": "float | None", + "description": "Current Account Total Goods Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_primary_income", + "type": "float | None", + "description": "Current Account Total Primary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_total_services", + "type": "float | None", + "description": "Current Account Credits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_goods", + "type": "float | None", + "description": "Current Account Credits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_primary_income", + "type": "float | None", + "description": "Current Account Credits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_secondary_income", + "type": "float | None", + "description": "Current Account Credits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total", + "type": "float | None", + "description": "Current Account Credits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_total_services", + "type": "float | None", + "description": "Current Account Debits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_goods", + "type": "float | None", + "description": "Current Account Debits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_primary_income", + "type": "float | None", + "description": "Current Account Debits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total", + "type": "float | None", + "description": "Current Account Debits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_secondary_income", + "type": "float | None", + "description": "Current Account Debits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "balance_percent_of_gdp", + "type": "float | None", + "description": "Current Account Balance as Percent of GDP (not provided by IMF BOP).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "balance_total", + "type": "float | None", + "description": "Current Account Total Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_services", + "type": "float | None", + "description": "Current Account Total Services Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_secondary_income", + "type": "float | None", + "description": "Current Account Total Secondary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_goods", + "type": "float | None", + "description": "Current Account Total Goods Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_primary_income", + "type": "float | None", + "description": "Current Account Total Primary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_total_services", + "type": "float | None", + "description": "Current Account Credits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_goods", + "type": "float | None", + "description": "Current Account Credits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_primary_income", + "type": "float | None", + "description": "Current Account Credits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_secondary_income", + "type": "float | None", + "description": "Current Account Credits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total", + "type": "float | None", + "description": "Current Account Credits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_total_services", + "type": "float | None", + "description": "Current Account Debits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_goods", + "type": "float | None", + "description": "Current Account Debits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_primary_income", + "type": "float | None", + "description": "Current Account Debits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total", + "type": "float | None", + "description": "Current Account Debits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_secondary_income", + "type": "float | None", + "description": "Current Account Debits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "ISO3 country code (or label) reported alongside each row.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ImfBalanceOfPayments", + "openapi_extra": { + "model": "ImfBalanceOfPayments" + } + }, + "/imf/direction_of_trade": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Direction Of Trade Statistics (DOTS) from the IMF database.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.imf.direction_of_trade(provider='imf', country='all', counterpart='china')\n# Select multiple countries or counterparts by entering a comma-separated list.\nobb.imf.direction_of_trade(provider='imf', country='us', counterpart='world,eu', frequency='annual', direction='exports')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple items allowed for provider(s): imf.", + "default": null, + "optional": true, + "choices": [ + "afghanistan", + "albania", + "algeria", + "american_samoa", + "angola", + "anguilla", + "antigua_and_barbuda", + "argentina", + "armenia", + "aruba", + "australia", + "austria", + "azerbaijan", + "bahamas", + "bahrain", + "bangladesh", + "barbados", + "belarus", + "belgium", + "belize", + "benin", + "bermuda", + "bhutan", + "bolivia", + "bosnia_and_herzegovina", + "botswana", + "brazil", + "brunei_darussalam", + "bulgaria", + "burkina_faso", + "burundi", + "cabo_verde", + "cambodia", + "cameroon", + "canada", + "central_african_republic", + "chad", + "chile", + "china", + "colombia", + "comoros", + "congo", + "costa_rica", + "croatia", + "cuba", + "cura\u00e7ao", + "cyprus", + "czech_republic", + "czechoslovakia", + "c\u00f4te_d'ivoire", + "denmark", + "djibouti", + "dominica", + "dominican_republic", + "ecuador", + "egypt", + "el_salvador", + "equatorial_guinea", + "eritrea", + "estonia", + "eswatini", + "ethiopia", + "falkland_islands", + "faroe_islands", + "fiji", + "finland", + "france", + "french_polynesia", + "gabon", + "gambia", + "georgia", + "german_democratic_republic", + "germany", + "ghana", + "gibraltar", + "greece", + "greenland", + "grenada", + "guam", + "guatemala", + "guinea", + "guinea_bissau", + "guyana", + "haiti", + "holy_see", + "honduras", + "hong_kong_special_administrative_region", + "hungary", + "iceland", + "india", + "indonesia", + "iran", + "iraq", + "ireland", + "israel", + "italy", + "jamaica", + "japan", + "jordan", + "kazakhstan", + "kenya", + "kiribati", + "korea", + "kosovo", + "kuwait", + "kyrgyz_republic", + "lao_people's_democratic_republic", + "latvia", + "lebanon", + "lesotho", + "liberia", + "libya", + "lithuania", + "luxembourg", + "macao_special_administrative_region", + "madagascar", + "malawi", + "malaysia", + "maldives", + "mali", + "malta", + "marshall_islands", + "mauritania", + "mauritius", + "mexico", + "micronesia", + "moldova", + "mongolia", + "montenegro", + "montserrat", + "morocco", + "mozambique", + "myanmar", + "namibia", + "naoero", + "nepal", + "netherlands_antilles", + "netherlands", + "new_caledonia", + "new_zealand", + "nicaragua", + "niger", + "nigeria", + "north_macedonia", + "norway", + "oman", + "pakistan", + "palau", + "panama", + "papua_new_guinea", + "paraguay", + "peru", + "philippines", + "poland", + "portugal", + "qatar", + "romania", + "russian_federation", + "rwanda", + "samoa", + "san_marino", + "saudi_arabia", + "senegal", + "serbia_and_montenegro", + "serbia", + "seychelles", + "sierra_leone", + "singapore", + "sint_maarten", + "slovak_republic", + "slovenia", + "solomon_islands", + "somalia", + "south_africa", + "south_sudan", + "spain", + "sri_lanka", + "st._kitts_and_nevis", + "st._lucia", + "st._vincent_and_the_grenadines", + "sudan", + "suriname", + "sweden", + "switzerland", + "syrian_arab_republic", + "s\u00e3o_tom\u00e9_and_pr\u00edncipe", + "tajikistan", + "tanzania", + "thailand", + "timor_leste", + "togo", + "tonga", + "trinidad_and_tobago", + "tunisia", + "turkmenistan", + "tuvalu", + "t\u00fcrkiye", + "uganda", + "ukraine", + "union_of_soviet_socialist_republics", + "united_arab_emirates", + "united_kingdom", + "united_states", + "uruguay", + "uzbekistan", + "vanuatu", + "venezuela", + "vietnam", + "west_bank_and_gaza", + "yemen_arab_republic", + "yemen", + "yugoslavia", + "zambia", + "zimbabwe", + "advanced_economies", + "africa", + "cis", + "emdes_by_source_of_export_earnings:_fuel", + "emdes_by_source_of_export_earnings:_nonfuel", + "emerging_market_and_developing_economies", + "emerging_and_developing_asia", + "emerging_and_developing_europe", + "euro_area", + "europe", + "european_union", + "latin_america_and_the_caribbean", + "middle_east", + "middle_east_and_central_asia", + "sub_saharan_africa", + "world", + "belgium_luxembourg", + "other_countries_n.i.e.", + "south_african_common_customs_area" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "multiple_items_allowed": true, + "choices": [ + "afghanistan", + "albania", + "algeria", + "american_samoa", + "angola", + "anguilla", + "antigua_and_barbuda", + "argentina", + "armenia", + "aruba", + "australia", + "austria", + "azerbaijan", + "bahamas", + "bahrain", + "bangladesh", + "barbados", + "belarus", + "belgium", + "belize", + "benin", + "bermuda", + "bhutan", + "bolivia", + "bosnia_and_herzegovina", + "botswana", + "brazil", + "brunei_darussalam", + "bulgaria", + "burkina_faso", + "burundi", + "cabo_verde", + "cambodia", + "cameroon", + "canada", + "central_african_republic", + "chad", + "chile", + "china", + "colombia", + "comoros", + "congo", + "costa_rica", + "croatia", + "cuba", + "cura\u00e7ao", + "cyprus", + "czech_republic", + "czechoslovakia", + "c\u00f4te_d'ivoire", + "denmark", + "djibouti", + "dominica", + "dominican_republic", + "ecuador", + "egypt", + "el_salvador", + "equatorial_guinea", + "eritrea", + "estonia", + "eswatini", + "ethiopia", + "falkland_islands", + "faroe_islands", + "fiji", + "finland", + "france", + "french_polynesia", + "gabon", + "gambia", + "georgia", + "german_democratic_republic", + "germany", + "ghana", + "gibraltar", + "greece", + "greenland", + "grenada", + "guam", + "guatemala", + "guinea", + "guinea_bissau", + "guyana", + "haiti", + "holy_see", + "honduras", + "hong_kong_special_administrative_region", + "hungary", + "iceland", + "india", + "indonesia", + "iran", + "iraq", + "ireland", + "israel", + "italy", + "jamaica", + "japan", + "jordan", + "kazakhstan", + "kenya", + "kiribati", + "korea", + "kosovo", + "kuwait", + "kyrgyz_republic", + "lao_people's_democratic_republic", + "latvia", + "lebanon", + "lesotho", + "liberia", + "libya", + "lithuania", + "luxembourg", + "macao_special_administrative_region", + "madagascar", + "malawi", + "malaysia", + "maldives", + "mali", + "malta", + "marshall_islands", + "mauritania", + "mauritius", + "mexico", + "micronesia", + "moldova", + "mongolia", + "montenegro", + "montserrat", + "morocco", + "mozambique", + "myanmar", + "namibia", + "naoero", + "nepal", + "netherlands_antilles", + "netherlands", + "new_caledonia", + "new_zealand", + "nicaragua", + "niger", + "nigeria", + "north_macedonia", + "norway", + "oman", + "pakistan", + "palau", + "panama", + "papua_new_guinea", + "paraguay", + "peru", + "philippines", + "poland", + "portugal", + "qatar", + "romania", + "russian_federation", + "rwanda", + "samoa", + "san_marino", + "saudi_arabia", + "senegal", + "serbia_and_montenegro", + "serbia", + "seychelles", + "sierra_leone", + "singapore", + "sint_maarten", + "slovak_republic", + "slovenia", + "solomon_islands", + "somalia", + "south_africa", + "south_sudan", + "spain", + "sri_lanka", + "st._kitts_and_nevis", + "st._lucia", + "st._vincent_and_the_grenadines", + "sudan", + "suriname", + "sweden", + "switzerland", + "syrian_arab_republic", + "s\u00e3o_tom\u00e9_and_pr\u00edncipe", + "tajikistan", + "tanzania", + "thailand", + "timor_leste", + "togo", + "tonga", + "trinidad_and_tobago", + "tunisia", + "turkmenistan", + "tuvalu", + "t\u00fcrkiye", + "uganda", + "ukraine", + "union_of_soviet_socialist_republics", + "united_arab_emirates", + "united_kingdom", + "united_states", + "uruguay", + "uzbekistan", + "vanuatu", + "venezuela", + "vietnam", + "west_bank_and_gaza", + "yemen_arab_republic", + "yemen", + "yugoslavia", + "zambia", + "zimbabwe", + "advanced_economies", + "africa", + "cis", + "emdes_by_source_of_export_earnings:_fuel", + "emdes_by_source_of_export_earnings:_nonfuel", + "emerging_market_and_developing_economies", + "emerging_and_developing_asia", + "emerging_and_developing_europe", + "euro_area", + "europe", + "european_union", + "latin_america_and_the_caribbean", + "middle_east", + "middle_east_and_central_asia", + "sub_saharan_africa", + "world", + "belgium_luxembourg", + "other_countries_n.i.e.", + "south_african_common_customs_area" + ], + "x-widget_config": { + "value": "united_states", + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "counterpart", + "type": "str | None | list[str | None]", + "description": "Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple items allowed for provider(s): imf.", + "default": null, + "optional": true, + "choices": [ + "all", + "afghanistan", + "albania", + "algeria", + "american_samoa", + "angola", + "anguilla", + "antigua_and_barbuda", + "argentina", + "armenia", + "aruba", + "australia", + "austria", + "azerbaijan", + "bahamas", + "bahrain", + "bangladesh", + "barbados", + "belarus", + "belgium", + "belize", + "benin", + "bermuda", + "bhutan", + "bolivia", + "bosnia_and_herzegovina", + "botswana", + "brazil", + "brunei_darussalam", + "bulgaria", + "burkina_faso", + "burundi", + "cabo_verde", + "cambodia", + "cameroon", + "canada", + "central_african_republic", + "chad", + "chile", + "china", + "colombia", + "comoros", + "congo", + "costa_rica", + "croatia", + "cuba", + "cura\u00e7ao", + "cyprus", + "czech_republic", + "czechoslovakia", + "c\u00f4te_d'ivoire", + "denmark", + "djibouti", + "dominica", + "dominican_republic", + "ecuador", + "egypt", + "el_salvador", + "equatorial_guinea", + "eritrea", + "estonia", + "eswatini", + "ethiopia", + "falkland_islands", + "faroe_islands", + "fiji", + "finland", + "france", + "french_polynesia", + "gabon", + "gambia", + "georgia", + "german_democratic_republic", + "germany", + "ghana", + "gibraltar", + "greece", + "greenland", + "grenada", + "guam", + "guatemala", + "guinea", + "guinea_bissau", + "guyana", + "haiti", + "holy_see", + "honduras", + "hong_kong_special_administrative_region", + "hungary", + "iceland", + "india", + "indonesia", + "iran", + "iraq", + "ireland", + "israel", + "italy", + "jamaica", + "japan", + "jordan", + "kazakhstan", + "kenya", + "kiribati", + "korea", + "kosovo", + "kuwait", + "kyrgyz_republic", + "lao_people's_democratic_republic", + "latvia", + "lebanon", + "lesotho", + "liberia", + "libya", + "lithuania", + "luxembourg", + "macao_special_administrative_region", + "madagascar", + "malawi", + "malaysia", + "maldives", + "mali", + "malta", + "marshall_islands", + "mauritania", + "mauritius", + "mexico", + "micronesia", + "moldova", + "mongolia", + "montenegro", + "montserrat", + "morocco", + "mozambique", + "myanmar", + "namibia", + "naoero", + "nepal", + "netherlands_antilles", + "netherlands", + "new_caledonia", + "new_zealand", + "nicaragua", + "niger", + "nigeria", + "north_macedonia", + "norway", + "oman", + "pakistan", + "palau", + "panama", + "papua_new_guinea", + "paraguay", + "peru", + "philippines", + "poland", + "portugal", + "qatar", + "romania", + "russian_federation", + "rwanda", + "samoa", + "san_marino", + "saudi_arabia", + "senegal", + "serbia_and_montenegro", + "serbia", + "seychelles", + "sierra_leone", + "singapore", + "sint_maarten", + "slovak_republic", + "slovenia", + "solomon_islands", + "somalia", + "south_africa", + "south_sudan", + "spain", + "sri_lanka", + "st._kitts_and_nevis", + "st._lucia", + "st._vincent_and_the_grenadines", + "sudan", + "suriname", + "sweden", + "switzerland", + "syrian_arab_republic", + "s\u00e3o_tom\u00e9_and_pr\u00edncipe", + "tajikistan", + "tanzania", + "thailand", + "timor_leste", + "togo", + "tonga", + "trinidad_and_tobago", + "tunisia", + "turkmenistan", + "tuvalu", + "t\u00fcrkiye", + "uganda", + "ukraine", + "union_of_soviet_socialist_republics", + "united_arab_emirates", + "united_kingdom", + "united_states", + "uruguay", + "uzbekistan", + "vanuatu", + "venezuela", + "vietnam", + "west_bank_and_gaza", + "yemen_arab_republic", + "yemen", + "yugoslavia", + "zambia", + "zimbabwe", + "advanced_economies", + "africa", + "cis", + "emdes_by_source_of_export_earnings:_fuel", + "emdes_by_source_of_export_earnings:_nonfuel", + "emerging_market_and_developing_economies", + "emerging_and_developing_asia", + "emerging_and_developing_europe", + "euro_area", + "europe", + "european_union", + "latin_america_and_the_caribbean", + "middle_east", + "middle_east_and_central_asia", + "sub_saharan_africa", + "world", + "belgium_luxembourg", + "other_countries_n.i.e.", + "south_african_common_customs_area" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "multiple_items_allowed": true, + "choices": [ + "all", + "afghanistan", + "albania", + "algeria", + "american_samoa", + "angola", + "anguilla", + "antigua_and_barbuda", + "argentina", + "armenia", + "aruba", + "australia", + "austria", + "azerbaijan", + "bahamas", + "bahrain", + "bangladesh", + "barbados", + "belarus", + "belgium", + "belize", + "benin", + "bermuda", + "bhutan", + "bolivia", + "bosnia_and_herzegovina", + "botswana", + "brazil", + "brunei_darussalam", + "bulgaria", + "burkina_faso", + "burundi", + "cabo_verde", + "cambodia", + "cameroon", + "canada", + "central_african_republic", + "chad", + "chile", + "china", + "colombia", + "comoros", + "congo", + "costa_rica", + "croatia", + "cuba", + "cura\u00e7ao", + "cyprus", + "czech_republic", + "czechoslovakia", + "c\u00f4te_d'ivoire", + "denmark", + "djibouti", + "dominica", + "dominican_republic", + "ecuador", + "egypt", + "el_salvador", + "equatorial_guinea", + "eritrea", + "estonia", + "eswatini", + "ethiopia", + "falkland_islands", + "faroe_islands", + "fiji", + "finland", + "france", + "french_polynesia", + "gabon", + "gambia", + "georgia", + "german_democratic_republic", + "germany", + "ghana", + "gibraltar", + "greece", + "greenland", + "grenada", + "guam", + "guatemala", + "guinea", + "guinea_bissau", + "guyana", + "haiti", + "holy_see", + "honduras", + "hong_kong_special_administrative_region", + "hungary", + "iceland", + "india", + "indonesia", + "iran", + "iraq", + "ireland", + "israel", + "italy", + "jamaica", + "japan", + "jordan", + "kazakhstan", + "kenya", + "kiribati", + "korea", + "kosovo", + "kuwait", + "kyrgyz_republic", + "lao_people's_democratic_republic", + "latvia", + "lebanon", + "lesotho", + "liberia", + "libya", + "lithuania", + "luxembourg", + "macao_special_administrative_region", + "madagascar", + "malawi", + "malaysia", + "maldives", + "mali", + "malta", + "marshall_islands", + "mauritania", + "mauritius", + "mexico", + "micronesia", + "moldova", + "mongolia", + "montenegro", + "montserrat", + "morocco", + "mozambique", + "myanmar", + "namibia", + "naoero", + "nepal", + "netherlands_antilles", + "netherlands", + "new_caledonia", + "new_zealand", + "nicaragua", + "niger", + "nigeria", + "north_macedonia", + "norway", + "oman", + "pakistan", + "palau", + "panama", + "papua_new_guinea", + "paraguay", + "peru", + "philippines", + "poland", + "portugal", + "qatar", + "romania", + "russian_federation", + "rwanda", + "samoa", + "san_marino", + "saudi_arabia", + "senegal", + "serbia_and_montenegro", + "serbia", + "seychelles", + "sierra_leone", + "singapore", + "sint_maarten", + "slovak_republic", + "slovenia", + "solomon_islands", + "somalia", + "south_africa", + "south_sudan", + "spain", + "sri_lanka", + "st._kitts_and_nevis", + "st._lucia", + "st._vincent_and_the_grenadines", + "sudan", + "suriname", + "sweden", + "switzerland", + "syrian_arab_republic", + "s\u00e3o_tom\u00e9_and_pr\u00edncipe", + "tajikistan", + "tanzania", + "thailand", + "timor_leste", + "togo", + "tonga", + "trinidad_and_tobago", + "tunisia", + "turkmenistan", + "tuvalu", + "t\u00fcrkiye", + "uganda", + "ukraine", + "union_of_soviet_socialist_republics", + "united_arab_emirates", + "united_kingdom", + "united_states", + "uruguay", + "uzbekistan", + "vanuatu", + "venezuela", + "vietnam", + "west_bank_and_gaza", + "yemen_arab_republic", + "yemen", + "yugoslavia", + "zambia", + "zimbabwe", + "advanced_economies", + "africa", + "cis", + "emdes_by_source_of_export_earnings:_fuel", + "emdes_by_source_of_export_earnings:_nonfuel", + "emerging_market_and_developing_economies", + "emerging_and_developing_asia", + "emerging_and_developing_europe", + "euro_area", + "europe", + "european_union", + "latin_america_and_the_caribbean", + "middle_east", + "middle_east_and_central_asia", + "sub_saharan_africa", + "world", + "belgium_luxembourg", + "other_countries_n.i.e.", + "south_african_common_customs_area" + ], + "x-widget_config": { + "value": "world", + "style": { + "popupWidth": 600 + } + } + } + } + }, + { + "name": "direction", + "type": "str | None", + "description": "Trade direction. Use 'all' to get all data for this dimension.", + "default": "balance", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "month", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of results returned, the most recent data points first.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfDirectionOfTrade", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "counterpart", + "type": "str", + "description": "Counterpart country or region to the trade.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Title corresponding to the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "Trade value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "scale", + "type": "str | None", + "description": "Scale of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "date", + "type": "date | int | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data. Concatenated series identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "The country or region to the trade.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "counterpart", + "type": "str", + "description": "Counterpart country or region to the trade.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Title corresponding to the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "Trade value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "scale", + "type": "str | None", + "description": "Scale of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str", + "description": "IMF country code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "counterpart_code", + "type": "str", + "description": "IMF counterpart country code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit_multiplier", + "type": "int | None", + "description": "Unit multiplier of the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ImfDirectionOfTrade", + "openapi_extra": { + "model": "ImfDirectionOfTrade" + } + }, + "/imf/port_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "General metadata and statistics for all IMF Port Watch ports.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.imf.port_info(provider='imf')\nobb.imf.port_info(provider='imf', continent='asia_pacific')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "continent", + "type": "str | None", + "description": "Filter by continent. This parameter is ignored when a `country` is provided.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "North America", + "value": "north_america" + }, + { + "label": "Europe", + "value": "europe" + }, + { + "label": "Asia & Pacific", + "value": "asia_pacific" + }, + { + "label": "South America", + "value": "south_america" + }, + { + "label": "Africa", + "value": "africa" + } + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Country to focus on. Enter as a 3-letter ISO country code. This parameter supersedes `continent` if both are provided.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "ALB" + }, + { + "label": "Algeria", + "value": "DZA" + }, + { + "label": "American Samoa", + "value": "ASM" + }, + { + "label": "Angola", + "value": "AGO" + }, + { + "label": "Anguilla", + "value": "AIA" + }, + { + "label": "Antigua and Barbuda", + "value": "ATG" + }, + { + "label": "Argentina", + "value": "ARG" + }, + { + "label": "Aruba", + "value": "ABW" + }, + { + "label": "Australia", + "value": "AUS" + }, + { + "label": "Azerbaijan", + "value": "AZE" + }, + { + "label": "Bahrain", + "value": "BHR" + }, + { + "label": "Bangladesh", + "value": "BGD" + }, + { + "label": "Barbados", + "value": "BRB" + }, + { + "label": "Belgium", + "value": "BEL" + }, + { + "label": "Belize", + "value": "BLZ" + }, + { + "label": "Benin", + "value": "BEN" + }, + { + "label": "Bonaire, Saint Eustatius and Saba", + "value": "BES" + }, + { + "label": "Brazil", + "value": "BRA" + }, + { + "label": "British Virgin Islands", + "value": "VGB" + }, + { + "label": "Brunei Darussalam", + "value": "BRN" + }, + { + "label": "Bulgaria", + "value": "BGR" + }, + { + "label": "Cabo Verde", + "value": "CPV" + }, + { + "label": "Cambodia", + "value": "KHM" + }, + { + "label": "Cameroon", + "value": "CMR" + }, + { + "label": "Canada", + "value": "CAN" + }, + { + "label": "Cayman Islands", + "value": "CYM" + }, + { + "label": "Chile", + "value": "CHL" + }, + { + "label": "China", + "value": "CHN" + }, + { + "label": "Colombia", + "value": "COL" + }, + { + "label": "Comoros", + "value": "COM" + }, + { + "label": "Cook Islands", + "value": "COK" + }, + { + "label": "Costa Rica", + "value": "CRI" + }, + { + "label": "Croatia", + "value": "HRV" + }, + { + "label": "Cuba", + "value": "CUB" + }, + { + "label": "Cura\u00e7ao", + "value": "CUW" + }, + { + "label": "Cyprus", + "value": "CYP" + }, + { + "label": "C\u00f4te d'Ivoire", + "value": "CIV" + }, + { + "label": "Democratic Republic of the Congo", + "value": "COD" + }, + { + "label": "Denmark", + "value": "DNK" + }, + { + "label": "Djibouti", + "value": "DJI" + }, + { + "label": "Dominica", + "value": "DMA" + }, + { + "label": "Dominican Republic", + "value": "DOM" + }, + { + "label": "Ecuador", + "value": "ECU" + }, + { + "label": "Egypt", + "value": "EGY" + }, + { + "label": "El Salvador", + "value": "SLV" + }, + { + "label": "Equatorial Guinea", + "value": "GNQ" + }, + { + "label": "Eritrea", + "value": "ERI" + }, + { + "label": "Estonia", + "value": "EST" + }, + { + "label": "Faroe Islands", + "value": "FRO" + }, + { + "label": "Fiji", + "value": "FJI" + }, + { + "label": "Finland", + "value": "FIN" + }, + { + "label": "France", + "value": "FRA" + }, + { + "label": "French Guiana", + "value": "GUF" + }, + { + "label": "French Polynesia", + "value": "PYF" + }, + { + "label": "Gabon", + "value": "GAB" + }, + { + "label": "Georgia", + "value": "GEO" + }, + { + "label": "Germany", + "value": "DEU" + }, + { + "label": "Ghana", + "value": "GHA" + }, + { + "label": "Gibraltar", + "value": "GIB" + }, + { + "label": "Greece", + "value": "GRC" + }, + { + "label": "Grenada", + "value": "GRD" + }, + { + "label": "Guadeloupe", + "value": "GLP" + }, + { + "label": "Guam", + "value": "GUM" + }, + { + "label": "Guatemala", + "value": "GTM" + }, + { + "label": "Guinea", + "value": "GIN" + }, + { + "label": "Guinea-Bissau", + "value": "GNB" + }, + { + "label": "Guyana", + "value": "GUY" + }, + { + "label": "Haiti", + "value": "HTI" + }, + { + "label": "Honduras", + "value": "HND" + }, + { + "label": "Hong Kong SAR", + "value": "HKG" + }, + { + "label": "Iceland", + "value": "ISL" + }, + { + "label": "India", + "value": "IND" + }, + { + "label": "Indonesia", + "value": "IDN" + }, + { + "label": "Iran", + "value": "IRN" + }, + { + "label": "Iraq", + "value": "IRQ" + }, + { + "label": "Ireland", + "value": "IRL" + }, + { + "label": "Israel", + "value": "ISR" + }, + { + "label": "Italy", + "value": "ITA" + }, + { + "label": "Jamaica", + "value": "JAM" + }, + { + "label": "Japan", + "value": "JPN" + }, + { + "label": "Jordan", + "value": "JOR" + }, + { + "label": "Kazakhstan", + "value": "KAZ" + }, + { + "label": "Kenya", + "value": "KEN" + }, + { + "label": "Kiribati", + "value": "KIR" + }, + { + "label": "Korea", + "value": "KOR" + }, + { + "label": "Kuwait", + "value": "KWT" + }, + { + "label": "Latvia", + "value": "LVA" + }, + { + "label": "Lebanon", + "value": "LBN" + }, + { + "label": "Liberia", + "value": "LBR" + }, + { + "label": "Libya", + "value": "LBY" + }, + { + "label": "Lithuania", + "value": "LTU" + }, + { + "label": "Macao SAR", + "value": "MAC" + }, + { + "label": "Madagascar", + "value": "MDG" + }, + { + "label": "Malaysia", + "value": "MYS" + }, + { + "label": "Maldives", + "value": "MDV" + }, + { + "label": "Malta", + "value": "MLT" + }, + { + "label": "Marshall Islands", + "value": "MHL" + }, + { + "label": "Martinique", + "value": "MTQ" + }, + { + "label": "Mauritania", + "value": "MRT" + }, + { + "label": "Mauritius", + "value": "MUS" + }, + { + "label": "Mayotte", + "value": "MYT" + }, + { + "label": "Mexico", + "value": "MEX" + }, + { + "label": "Micronesia", + "value": "FSM" + }, + { + "label": "Moldova", + "value": "MDA" + }, + { + "label": "Montenegro", + "value": "MNE" + }, + { + "label": "Montserrat", + "value": "MSR" + }, + { + "label": "Morocco", + "value": "MAR" + }, + { + "label": "Mozambique", + "value": "MOZ" + }, + { + "label": "Myanmar", + "value": "MMR" + }, + { + "label": "Namibia", + "value": "NAM" + }, + { + "label": "Nauru", + "value": "NRU" + }, + { + "label": "New Caledonia", + "value": "NCL" + }, + { + "label": "New Zealand", + "value": "NZL" + }, + { + "label": "Nicaragua", + "value": "NIC" + }, + { + "label": "Nigeria", + "value": "NGA" + }, + { + "label": "Northern Mariana Islands", + "value": "MNP" + }, + { + "label": "Norway", + "value": "NOR" + }, + { + "label": "Oman", + "value": "OMN" + }, + { + "label": "Pakistan", + "value": "PAK" + }, + { + "label": "Palau", + "value": "PLW" + }, + { + "label": "Panama", + "value": "PAN" + }, + { + "label": "Papua New Guinea", + "value": "PNG" + }, + { + "label": "Peru", + "value": "PER" + }, + { + "label": "Philippines", + "value": "PHL" + }, + { + "label": "Poland", + "value": "POL" + }, + { + "label": "Portugal", + "value": "PRT" + }, + { + "label": "Puerto Rico", + "value": "PRI" + }, + { + "label": "Qatar", + "value": "QAT" + }, + { + "label": "Republic of Congo", + "value": "COG" + }, + { + "label": "Romania", + "value": "ROU" + }, + { + "label": "Russian Federation", + "value": "RUS" + }, + { + "label": "R\u00e9union", + "value": "REU" + }, + { + "label": "Saint Martin", + "value": "MAF" + }, + { + "label": "Saint-Barth\u00e9lemy", + "value": "BLM" + }, + { + "label": "Samoa", + "value": "WSM" + }, + { + "label": "Saudi Arabia", + "value": "SAU" + }, + { + "label": "Senegal", + "value": "SEN" + }, + { + "label": "Seychelles", + "value": "SYC" + }, + { + "label": "Sierra Leone", + "value": "SLE" + }, + { + "label": "Singapore", + "value": "SGP" + }, + { + "label": "Sint Maarten", + "value": "SXM" + }, + { + "label": "Slovenia", + "value": "SVN" + }, + { + "label": "Solomon Islands", + "value": "SLB" + }, + { + "label": "Somalia", + "value": "SOM" + }, + { + "label": "South Africa", + "value": "ZAF" + }, + { + "label": "Spain", + "value": "ESP" + }, + { + "label": "Sri Lanka", + "value": "LKA" + }, + { + "label": "St. Kitts and Nevis", + "value": "KNA" + }, + { + "label": "St. Lucia", + "value": "LCA" + }, + { + "label": "St. Vincent and the Grenadines", + "value": "VCT" + }, + { + "label": "Sudan", + "value": "SDN" + }, + { + "label": "Suriname", + "value": "SUR" + }, + { + "label": "Sweden", + "value": "SWE" + }, + { + "label": "Syria", + "value": "SYR" + }, + { + "label": "S\u00e3o Tom\u00e9 and Pr\u00edncipe", + "value": "STP" + }, + { + "label": "Taiwan Province of China", + "value": "TWN" + }, + { + "label": "Tanzania", + "value": "TZA" + }, + { + "label": "Thailand", + "value": "THA" + }, + { + "label": "The Bahamas", + "value": "BHS" + }, + { + "label": "The Gambia", + "value": "GMB" + }, + { + "label": "The Netherlands", + "value": "NLD" + }, + { + "label": "Timor-Leste", + "value": "TLS" + }, + { + "label": "Togo", + "value": "TGO" + }, + { + "label": "Tonga", + "value": "TON" + }, + { + "label": "Trinidad and Tobago", + "value": "TTO" + }, + { + "label": "Tunisia", + "value": "TUN" + }, + { + "label": "Turkmenistan", + "value": "TKM" + }, + { + "label": "Turks and Caicos Islands", + "value": "TCA" + }, + { + "label": "Tuvalu", + "value": "TUV" + }, + { + "label": "T\u00fcrkiye", + "value": "TUR" + }, + { + "label": "Ukraine", + "value": "UKR" + }, + { + "label": "United Arab Emirates", + "value": "ARE" + }, + { + "label": "United Kingdom", + "value": "GBR" + }, + { + "label": "United States", + "value": "USA" + }, + { + "label": "United States Virgin Islands", + "value": "VIR" + }, + { + "label": "Uruguay", + "value": "URY" + }, + { + "label": "Vanuatu", + "value": "VUT" + }, + { + "label": "Venezuela", + "value": "VEN" + }, + { + "label": "Vietnam", + "value": "VNM" + }, + { + "label": "Yemen", + "value": "YEM" + } + ], + "description": "Filter by country. This parameter supersedes `continent` if both are provided.", + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "port_code", + "type": "str | None", + "description": "This is a dummy parameter to allow grouping in OpenBB Workspace widgets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "description": "Dummy parameter for widget grouping." + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of results returned. Limit is determined by the annual average number of vessels transiting through the port. If not provided, all ports are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfPortInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "port_code", + "type": "str", + "description": "Unique ID assigned to the port by the source.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "port_code", + "type": "str", + "description": "Unique ID assigned to the port.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "description": "Unique ID assigned to the port. Click on a value to change the widget group value.", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "port_code" + } + } + } + }, + { + "name": "continent", + "type": "str", + "description": "Continent where the port is located.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "Country where the port is located.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str", + "description": "3-letter ISO code of the country where the port is located.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "port_name", + "type": "str", + "description": "Port name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "port_full_name", + "type": "str", + "description": "Full name of the port.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float", + "description": "Latitude of the port.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float", + "description": "Longitude of the port.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_total", + "type": "int", + "description": "Yearly average number of all ships transiting through the port. Estimated using AIS data beginning 2019. The total is calculated over the sum of vessel_count_container, vessel_count_dry_bulk, vessel_count_general_cargo, vessel_count_roro and vessel_count_tanker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_tanker", + "type": "int", + "description": "Yearly average number of tankers transiting through the port. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_container", + "type": "int", + "description": "Yearly average number of containers transiting through the port. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_general_cargo", + "type": "int", + "description": "Yearly average number of general cargo ships transiting through the port. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_dry_bulk", + "type": "int", + "description": "Yearly average number of dry bulk carriers transiting through the port. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_roro", + "type": "int", + "description": "Yearly average number of Ro-Ro ships transiting through the port. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "industry_top1", + "type": "str | None", + "description": "First dominant traded industries based on the volume of goods estimated to flow through the port.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_top2", + "type": "str | None", + "description": "Second dominant traded industries based on the volume of goods estimated to flow through the port.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_top3", + "type": "str | None", + "description": "Third dominant traded industries based on the volume of goods estimated to flow through the port.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "share_country_maritime_import", + "type": "float", + "description": "Share of the total maritime imports of the country that are estimated to flow through the port.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "share_country_maritime_export", + "type": "float", + "description": "Share of the total maritime exports of the country that are estimated to flow through the port.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "ImfPortInfo", + "openapi_extra": { + "model": "ImfPortInfo" + } + }, + "/imf/port_volume": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily port calls and estimated trading volumes from IMF Port Watch.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily port calls and estimated trading volumes for specific ports.\nobb.imf.port_volume(provider='imf', port_code='rotterdam,singapore')\n# All ports in a specific country (ISO3 code).\nobb.imf.port_volume(provider='imf', country='GBR')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "imf": { + "description": "Start date for the data query. Minimum is 2019-01-01.", + "x-widget_config": { + "type": "date", + "value": "2019-01-01" + } + } + } + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "port_code", + "type": "str | None | list[str | None]", + "description": "Port code to filter results by a specific port. This parameter is ignored if `country` parameter is provided. To get a list of available ports, use `obb.economy.shipping.port_info()`. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "optionsEndpoint": "/api/v1/imf/portwatch/list_port_id_choices", + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Country to focus on. Enter as a 3-letter ISO country code. This parameter is overridden by `port_code` if both are provided.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "ALB" + }, + { + "label": "Algeria", + "value": "DZA" + }, + { + "label": "American Samoa", + "value": "ASM" + }, + { + "label": "Angola", + "value": "AGO" + }, + { + "label": "Anguilla", + "value": "AIA" + }, + { + "label": "Antigua and Barbuda", + "value": "ATG" + }, + { + "label": "Argentina", + "value": "ARG" + }, + { + "label": "Aruba", + "value": "ABW" + }, + { + "label": "Australia", + "value": "AUS" + }, + { + "label": "Azerbaijan", + "value": "AZE" + }, + { + "label": "Bahrain", + "value": "BHR" + }, + { + "label": "Bangladesh", + "value": "BGD" + }, + { + "label": "Barbados", + "value": "BRB" + }, + { + "label": "Belgium", + "value": "BEL" + }, + { + "label": "Belize", + "value": "BLZ" + }, + { + "label": "Benin", + "value": "BEN" + }, + { + "label": "Bonaire, Saint Eustatius and Saba", + "value": "BES" + }, + { + "label": "Brazil", + "value": "BRA" + }, + { + "label": "British Virgin Islands", + "value": "VGB" + }, + { + "label": "Brunei Darussalam", + "value": "BRN" + }, + { + "label": "Bulgaria", + "value": "BGR" + }, + { + "label": "Cabo Verde", + "value": "CPV" + }, + { + "label": "Cambodia", + "value": "KHM" + }, + { + "label": "Cameroon", + "value": "CMR" + }, + { + "label": "Canada", + "value": "CAN" + }, + { + "label": "Cayman Islands", + "value": "CYM" + }, + { + "label": "Chile", + "value": "CHL" + }, + { + "label": "China", + "value": "CHN" + }, + { + "label": "Colombia", + "value": "COL" + }, + { + "label": "Comoros", + "value": "COM" + }, + { + "label": "Cook Islands", + "value": "COK" + }, + { + "label": "Costa Rica", + "value": "CRI" + }, + { + "label": "Croatia", + "value": "HRV" + }, + { + "label": "Cuba", + "value": "CUB" + }, + { + "label": "Cura\u00e7ao", + "value": "CUW" + }, + { + "label": "Cyprus", + "value": "CYP" + }, + { + "label": "C\u00f4te d'Ivoire", + "value": "CIV" + }, + { + "label": "Democratic Republic of the Congo", + "value": "COD" + }, + { + "label": "Denmark", + "value": "DNK" + }, + { + "label": "Djibouti", + "value": "DJI" + }, + { + "label": "Dominica", + "value": "DMA" + }, + { + "label": "Dominican Republic", + "value": "DOM" + }, + { + "label": "Ecuador", + "value": "ECU" + }, + { + "label": "Egypt", + "value": "EGY" + }, + { + "label": "El Salvador", + "value": "SLV" + }, + { + "label": "Equatorial Guinea", + "value": "GNQ" + }, + { + "label": "Eritrea", + "value": "ERI" + }, + { + "label": "Estonia", + "value": "EST" + }, + { + "label": "Faroe Islands", + "value": "FRO" + }, + { + "label": "Fiji", + "value": "FJI" + }, + { + "label": "Finland", + "value": "FIN" + }, + { + "label": "France", + "value": "FRA" + }, + { + "label": "French Guiana", + "value": "GUF" + }, + { + "label": "French Polynesia", + "value": "PYF" + }, + { + "label": "Gabon", + "value": "GAB" + }, + { + "label": "Georgia", + "value": "GEO" + }, + { + "label": "Germany", + "value": "DEU" + }, + { + "label": "Ghana", + "value": "GHA" + }, + { + "label": "Gibraltar", + "value": "GIB" + }, + { + "label": "Greece", + "value": "GRC" + }, + { + "label": "Grenada", + "value": "GRD" + }, + { + "label": "Guadeloupe", + "value": "GLP" + }, + { + "label": "Guam", + "value": "GUM" + }, + { + "label": "Guatemala", + "value": "GTM" + }, + { + "label": "Guinea", + "value": "GIN" + }, + { + "label": "Guinea-Bissau", + "value": "GNB" + }, + { + "label": "Guyana", + "value": "GUY" + }, + { + "label": "Haiti", + "value": "HTI" + }, + { + "label": "Honduras", + "value": "HND" + }, + { + "label": "Hong Kong SAR", + "value": "HKG" + }, + { + "label": "Iceland", + "value": "ISL" + }, + { + "label": "India", + "value": "IND" + }, + { + "label": "Indonesia", + "value": "IDN" + }, + { + "label": "Iran", + "value": "IRN" + }, + { + "label": "Iraq", + "value": "IRQ" + }, + { + "label": "Ireland", + "value": "IRL" + }, + { + "label": "Israel", + "value": "ISR" + }, + { + "label": "Italy", + "value": "ITA" + }, + { + "label": "Jamaica", + "value": "JAM" + }, + { + "label": "Japan", + "value": "JPN" + }, + { + "label": "Jordan", + "value": "JOR" + }, + { + "label": "Kazakhstan", + "value": "KAZ" + }, + { + "label": "Kenya", + "value": "KEN" + }, + { + "label": "Kiribati", + "value": "KIR" + }, + { + "label": "Korea", + "value": "KOR" + }, + { + "label": "Kuwait", + "value": "KWT" + }, + { + "label": "Latvia", + "value": "LVA" + }, + { + "label": "Lebanon", + "value": "LBN" + }, + { + "label": "Liberia", + "value": "LBR" + }, + { + "label": "Libya", + "value": "LBY" + }, + { + "label": "Lithuania", + "value": "LTU" + }, + { + "label": "Macao SAR", + "value": "MAC" + }, + { + "label": "Madagascar", + "value": "MDG" + }, + { + "label": "Malaysia", + "value": "MYS" + }, + { + "label": "Maldives", + "value": "MDV" + }, + { + "label": "Malta", + "value": "MLT" + }, + { + "label": "Marshall Islands", + "value": "MHL" + }, + { + "label": "Martinique", + "value": "MTQ" + }, + { + "label": "Mauritania", + "value": "MRT" + }, + { + "label": "Mauritius", + "value": "MUS" + }, + { + "label": "Mayotte", + "value": "MYT" + }, + { + "label": "Mexico", + "value": "MEX" + }, + { + "label": "Micronesia", + "value": "FSM" + }, + { + "label": "Moldova", + "value": "MDA" + }, + { + "label": "Montenegro", + "value": "MNE" + }, + { + "label": "Montserrat", + "value": "MSR" + }, + { + "label": "Morocco", + "value": "MAR" + }, + { + "label": "Mozambique", + "value": "MOZ" + }, + { + "label": "Myanmar", + "value": "MMR" + }, + { + "label": "Namibia", + "value": "NAM" + }, + { + "label": "Nauru", + "value": "NRU" + }, + { + "label": "New Caledonia", + "value": "NCL" + }, + { + "label": "New Zealand", + "value": "NZL" + }, + { + "label": "Nicaragua", + "value": "NIC" + }, + { + "label": "Nigeria", + "value": "NGA" + }, + { + "label": "Northern Mariana Islands", + "value": "MNP" + }, + { + "label": "Norway", + "value": "NOR" + }, + { + "label": "Oman", + "value": "OMN" + }, + { + "label": "Pakistan", + "value": "PAK" + }, + { + "label": "Palau", + "value": "PLW" + }, + { + "label": "Panama", + "value": "PAN" + }, + { + "label": "Papua New Guinea", + "value": "PNG" + }, + { + "label": "Peru", + "value": "PER" + }, + { + "label": "Philippines", + "value": "PHL" + }, + { + "label": "Poland", + "value": "POL" + }, + { + "label": "Portugal", + "value": "PRT" + }, + { + "label": "Puerto Rico", + "value": "PRI" + }, + { + "label": "Qatar", + "value": "QAT" + }, + { + "label": "Republic of Congo", + "value": "COG" + }, + { + "label": "Romania", + "value": "ROU" + }, + { + "label": "Russian Federation", + "value": "RUS" + }, + { + "label": "R\u00e9union", + "value": "REU" + }, + { + "label": "Saint Martin", + "value": "MAF" + }, + { + "label": "Saint-Barth\u00e9lemy", + "value": "BLM" + }, + { + "label": "Samoa", + "value": "WSM" + }, + { + "label": "Saudi Arabia", + "value": "SAU" + }, + { + "label": "Senegal", + "value": "SEN" + }, + { + "label": "Seychelles", + "value": "SYC" + }, + { + "label": "Sierra Leone", + "value": "SLE" + }, + { + "label": "Singapore", + "value": "SGP" + }, + { + "label": "Sint Maarten", + "value": "SXM" + }, + { + "label": "Slovenia", + "value": "SVN" + }, + { + "label": "Solomon Islands", + "value": "SLB" + }, + { + "label": "Somalia", + "value": "SOM" + }, + { + "label": "South Africa", + "value": "ZAF" + }, + { + "label": "Spain", + "value": "ESP" + }, + { + "label": "Sri Lanka", + "value": "LKA" + }, + { + "label": "St. Kitts and Nevis", + "value": "KNA" + }, + { + "label": "St. Lucia", + "value": "LCA" + }, + { + "label": "St. Vincent and the Grenadines", + "value": "VCT" + }, + { + "label": "Sudan", + "value": "SDN" + }, + { + "label": "Suriname", + "value": "SUR" + }, + { + "label": "Sweden", + "value": "SWE" + }, + { + "label": "Syria", + "value": "SYR" + }, + { + "label": "S\u00e3o Tom\u00e9 and Pr\u00edncipe", + "value": "STP" + }, + { + "label": "Taiwan Province of China", + "value": "TWN" + }, + { + "label": "Tanzania", + "value": "TZA" + }, + { + "label": "Thailand", + "value": "THA" + }, + { + "label": "The Bahamas", + "value": "BHS" + }, + { + "label": "The Gambia", + "value": "GMB" + }, + { + "label": "The Netherlands", + "value": "NLD" + }, + { + "label": "Timor-Leste", + "value": "TLS" + }, + { + "label": "Togo", + "value": "TGO" + }, + { + "label": "Tonga", + "value": "TON" + }, + { + "label": "Trinidad and Tobago", + "value": "TTO" + }, + { + "label": "Tunisia", + "value": "TUN" + }, + { + "label": "Turkmenistan", + "value": "TKM" + }, + { + "label": "Turks and Caicos Islands", + "value": "TCA" + }, + { + "label": "Tuvalu", + "value": "TUV" + }, + { + "label": "T\u00fcrkiye", + "value": "TUR" + }, + { + "label": "Ukraine", + "value": "UKR" + }, + { + "label": "United Arab Emirates", + "value": "ARE" + }, + { + "label": "United Kingdom", + "value": "GBR" + }, + { + "label": "United States", + "value": "USA" + }, + { + "label": "United States Virgin Islands", + "value": "VIR" + }, + { + "label": "Uruguay", + "value": "URY" + }, + { + "label": "Vanuatu", + "value": "VUT" + }, + { + "label": "Venezuela", + "value": "VEN" + }, + { + "label": "Vietnam", + "value": "VNM" + }, + { + "label": "Yemen", + "value": "YEM" + } + ], + "description": "Filter by country. This parameter is overridden by `port_code` if both are provided.", + "style": { + "popupWidth": 350 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfPortVolume", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "port_code", + "type": "str | None", + "description": "Port code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "port_name", + "type": "str | None", + "description": "Port name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country where the port is located.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "country_code", + "type": "str", + "description": "3-letter ISO country code of the country where the port is located.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portcalls", + "type": "int", + "description": "Total number of ships entering the port at this date. This is the sum of portcalls_container, portcalls_dry_bulk, portcalls_general_cargo, portcalls_roro and portcalls_tanker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portcalls_tanker", + "type": "int", + "description": "Number of tankers transiting through the chokepoint or making a port call.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portcalls_container", + "type": "int", + "description": "Number of containers transiting through the chokepoint or making a port call.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portcalls_general_cargo", + "type": "int", + "description": "Number of general cargo ships transiting through the chokepoint or making a port call.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portcalls_dry_bulk", + "type": "int", + "description": "Number of dry bulk carriers transiting through the chokepoint or making a port call.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portcalls_roro", + "type": "int", + "description": "Number of Ro-Ro ships transiting through the chokepoint or making a port call.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "imports", + "type": "float", + "description": "Total import volume (in metric tons) of all ships entering the port at this date. This is the sum of import_container, import_dry_bulk, import_general_cargo, import_roro and import_tanker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "imports_cargo", + "type": "float", + "description": "Total import volume (in metric tons) of all ships (excluding tankers) entering the port at this date. This is the sum of import_container, import_dry_bulk, import_general_cargo and import_roro.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "imports_tanker", + "type": "float", + "description": "Total import volume (in metric tons) of tankers entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "imports_container", + "type": "float", + "description": "Total import volume (in metric tons) of all container ships entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "imports_general_cargo", + "type": "float", + "description": "Total import volume (in metric tons) of general cargo ships entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "imports_dry_bulk", + "type": "float", + "description": "Total import volume (in metric tons) of dry bulk carriers entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "imports_roro", + "type": "float", + "description": "Total import volume (in metric tons) of Ro-Ro ships entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports", + "type": "float", + "description": "Total export volume (in metric tons) of all ships entering the port at this date. This is the sum of export_container, export_dry_bulk, export_general_cargo, export_roro and export_tanker.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports_cargo", + "type": "float", + "description": "Total export volume (in metric tons) of all ships (excluding tankers) entering the port at this date. This is the sum of export_container, export_dry_bulk, export_general_cargo and export_roro.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports_tanker", + "type": "float", + "description": "Total export volume (in metric tons) of tankers entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports_container", + "type": "float", + "description": "Total export volume (in metric tons) of all container ships entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports_general_cargo", + "type": "float", + "description": "Total export volume (in metric tons) of general cargo ships entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports_dry_bulk", + "type": "float", + "description": "Total export volume (in metric tons) of dry bulk carriers entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "exports_roro", + "type": "float", + "description": "Total export volume (in metric tons) of Ro-Ro ships entering the port at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + } + ] + }, + "model": "ImfPortVolume", + "openapi_extra": { + "model": "ImfPortVolume" + } + }, + "/imf/chokepoint_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Metadata and statistics for all IMF Port Watch maritime chokepoints.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.imf.chokepoint_info(provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "theme", + "type": "str | None", + "description": "Theme for the map. Only valid if `openbb-charting` is installed and `chart` parameter is set to `true`. Default is the 'chart_style' setting in `user_settings.json`, if available, otherwise 'dark'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfMaritimeChokePointInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "chokepoint_code", + "type": "str", + "description": "Unique ID assigned to the chokepoint by the source.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "name", + "type": "str", + "description": "Port name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float", + "description": "Latitude of the chokepoint location.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float", + "description": "Longitude of the chokepoint location.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_total", + "type": "int", + "description": "Yearly average number of all ships transiting through the chokepoint. Estimated using AIS data beginning 2019. The total is calculated over the sum of vessel_count_container, vessel_count_dry_bulk, vessel_count_general_cargo, vessel_count_roro and vessel_count_tanker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_tanker", + "type": "int", + "description": "Yearly average number of tankers transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_container", + "type": "int", + "description": "Yearly average number of containers transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_general_cargo", + "type": "int", + "description": "Yearly average number of general cargo ships transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_dry_bulk", + "type": "int", + "description": "Yearly average number of dry bulk carriers transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessel_count_roro", + "type": "int", + "description": "Yearly average number of Ro-Ro ships transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "industry_top1", + "type": "str | None", + "description": "First dominant traded industries based on the volume of goods estimated to flow through the chokepoint.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_top2", + "type": "str | None", + "description": "Second dominant traded industries based on the volume of goods estimated to flow through the chokepoint.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_top3", + "type": "str | None", + "description": "Third dominant traded industries based on the volume of goods estimated to flow through the chokepoint.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ImfMaritimeChokePointInfo", + "openapi_extra": { + "model": "ImfMaritimeChokePointInfo" + } + }, + "/imf/chokepoint_volume": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily transit calls and estimated trade volumes for shipping chokepoints.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.imf.chokepoint_volume(provider='imf')\nobb.imf.chokepoint_volume(provider='imf', chokepoint='suez_canal,panama_canal')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "chokepoint", + "type": "str | None | list[str | None]", + "description": "Name of the chokepoint. Use `None` for all chokepoints. Choices are: \n - suez_canal\n - panama_canal\n - bosporus_strait\n - bab_el_mandeb_strait\n - malacca_strait\n - strait_of_hormuz\n - cape_of_good_hope\n - gibraltar_strait\n - dover_strait\n - oresund_strait\n - taiwan_strait\n - korea_strait\n - tsugaru_strait\n - luzon_strait\n - lombok_strait\n - ombai_strait\n - bohai_strait\n - torres_strait\n - sunda_strait\n - makassar_strait\n - magellan_strait\n - yucatan_channel\n - windward_passage\n - mona_passage Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Suez Canal", + "value": "chokepoint1" + }, + { + "label": "Panama Canal", + "value": "chokepoint2" + }, + { + "label": "Bosporus Strait", + "value": "chokepoint3" + }, + { + "label": "Bab El-Mandeb Strait", + "value": "chokepoint4" + }, + { + "label": "Malacca Strait", + "value": "chokepoint5" + }, + { + "label": "Strait Of Hormuz", + "value": "chokepoint6" + }, + { + "label": "Cape Of Good Hope", + "value": "chokepoint7" + }, + { + "label": "Gibraltar Strait", + "value": "chokepoint8" + }, + { + "label": "Dover Strait", + "value": "chokepoint9" + }, + { + "label": "Oresund Strait", + "value": "chokepoint10" + }, + { + "label": "Taiwan Strait", + "value": "chokepoint11" + }, + { + "label": "Korea Strait", + "value": "chokepoint12" + }, + { + "label": "Tsugaru Strait", + "value": "chokepoint13" + }, + { + "label": "Luzon Strait", + "value": "chokepoint14" + }, + { + "label": "Lombok Strait", + "value": "chokepoint15" + }, + { + "label": "Ombai Strait", + "value": "chokepoint16" + }, + { + "label": "Bohai Strait", + "value": "chokepoint17" + }, + { + "label": "Torres Strait", + "value": "chokepoint18" + }, + { + "label": "Sunda Strait", + "value": "chokepoint19" + }, + { + "label": "Makassar Strait", + "value": "chokepoint20" + }, + { + "label": "Magellan Strait", + "value": "chokepoint21" + }, + { + "label": "Yucatan Channel", + "value": "chokepoint22" + }, + { + "label": "Windward Passage", + "value": "chokepoint23" + }, + { + "label": "Mona Passage", + "value": "chokepoint24" + } + ], + "description": "Name of the chokepoint. No selection will return data for all chokepoints." + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ImfMaritimeChokePointVolume", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "imf": [ + { + "name": "chokepoint", + "type": "str", + "description": "Name of the chokepoint.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_total", + "type": "int", + "description": "Number of all ships transiting through the chokepoint on that date. The total is calculated over the sum of vessels_container, vessels_dry_bulk, vessels_general_cargo, vessels_roro and vessels_tanker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_cargo", + "type": "int", + "description": "Total number of ships (excluding tankers) transiting through the chokepoint at this date. This is the sum of vessels_container, vessels_dry_bulk, vessels_general_cargo and vessels_roro.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_tanker", + "type": "int", + "description": "Number of tankers transiting through the chokepoint on that date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_container", + "type": "int", + "description": "Number of containers transiting through the chokepoint on that date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_general_cargo", + "type": "int", + "description": "Number of general cargo ships transiting through the chokepoint on that date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_dry_bulk", + "type": "int", + "description": "Yearly average number of dry bulk carriers transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vessels_roro", + "type": "int", + "description": "Yearly average number of Ro-Ro ships transiting through the chokepoint. Estimated using AIS data beginning 2019.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "capacity_total", + "type": "float", + "description": "Total trade volume (in metric tons) of all ships transiting through the chokepoint at this date. This is the sum of capacity_container, capacity_dry_bulk, capacity_general_cargo, capacity_roro and capacity_tanker.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "capacity_cargo", + "type": "float", + "description": "Total trade volume (in metric tons) of all ships (excluding tankers) transiting through the chokepoint at this date. This is the sum of capacity_container, capacity_dry_bulk, capacity_general_cargo and capacity_roro.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "capacity_tanker", + "type": "float", + "description": "Total trade volume (in metric tons) of tankers transiting through the chokepoint at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "capacity_container", + "type": "float", + "description": "Total trade volume (in metric tons) of containers transiting through the chokepoint at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "capacity_general_cargo", + "type": "float", + "description": "Total trade volume (in metric tons) of general cargo Vessels transiting through the chokepoint at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "capacity_dry_bulk", + "type": "float", + "description": "Total trade volume (in metric tons) of dry bulk carriers transiting through the chokepoint at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + }, + { + "name": "capacity_roro", + "type": "float", + "description": "Total trade volume (in metric tons) of Ro-Ro ships transiting through the chokepoint at this date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "metric_tons", + "x-widget_config": { + "suffix": "mt" + } + } + } + ] + }, + "model": "ImfMaritimeChokePointVolume", + "openapi_extra": { + "model": "ImfMaritimeChokePointVolume" + } + }, + "/imf/portwatch/list_port_id_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of IMF Port Watch port IDs.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get port ID choices for IMF Port Watch.\n >>> obb.imf.portwatch.list_port_id_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get port ID choices for IMF Port Watch.\nobb.imf.portwatch.list_port_id_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/portwatch/list_country_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of ISO3 countries from the IMF Port Watch ports database.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # ISO3 country choices.\n >>> obb.imf.portwatch.list_country_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# ISO3 country choices.\nobb.imf.portwatch.list_country_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/portwatch/list_tradenow_region_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of TradeNow regions for dropdown widgets.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Tradenow regions.\n >>> obb.imf.portwatch.list_tradenow_region_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Tradenow regions.\nobb.imf.portwatch.list_tradenow_region_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/portwatch/list_container_port_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of ports present in the Container Metrics table, with TOP10.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Container metric ports.\n >>> obb.imf.portwatch.list_container_port_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Container metric ports.\nobb.imf.portwatch.list_container_port_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/portwatch/list_disruption_event_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of disruption events ordered by start date, with LATEST.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Disruption events.\n >>> obb.imf.portwatch.list_disruption_event_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Disruption events.\nobb.imf.portwatch.list_disruption_event_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/imf/portwatch/country_activity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily country-level port calls, imports, and exports from IMF Port Watch.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily maritime activity for the USA.\nobb.imf.portwatch.country_activity(country_code='USA', provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "country_code", + "type": "str | None", + "description": "ISO3 country code to fetch daily activity for.", + "default": "USA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/portwatch/list_country_choices", + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "metric", + "type": "str | None", + "description": "Activity metric to chart: 'portcalls', 'import', or 'export'.", + "default": "portcalls", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "options": [ + { + "label": "Port Calls", + "value": "portcalls" + }, + { + "label": "Imports (mt)", + "value": "import" + }, + { + "label": "Exports (mt)", + "value": "export" + } + ] + } + } + }, + { + "name": "start_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) lower bound for the activity window.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "end_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) upper bound for the activity window.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "theme", + "type": "str | None", + "description": "Theme for the chart. Only used when ``chart=True``.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CountryActivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "imf": [ + { + "name": "date", + "type": "str | str", + "description": "Observation date (YYYY-MM-DD).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str", + "description": "ISO3 country code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country display name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls", + "type": "int | None", + "description": "Total ships calling at the country's ports on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_cargo", + "type": "int | None", + "description": "Total cargo ships (excluding tankers) calling on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_container", + "type": "int | None", + "description": "Container-ship port calls on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_dry_bulk", + "type": "int | None", + "description": "Dry-bulk-carrier port calls on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_general_cargo", + "type": "int | None", + "description": "General-cargo-ship port calls on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_roro", + "type": "int | None", + "description": "Ro-Ro-ship port calls on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_tanker", + "type": "int | None", + "description": "Tanker port calls on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_container_30ma", + "type": "float | None", + "description": "30-day moving average of container port calls.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portcalls_container_30ma_yoy_doy", + "type": "float | None", + "description": "Year-over-year change in the 30-day MA of container port calls, keyed on day of year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports", + "type": "int | None", + "description": "Total import volume (mt) of all ships entering on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_cargo", + "type": "int | None", + "description": "Total import volume (mt) of cargo ships (excluding tankers).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_container", + "type": "int | None", + "description": "Total import volume (mt) of container ships on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_dry_bulk", + "type": "int | None", + "description": "Total import volume (mt) of dry-bulk carriers on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_general_cargo", + "type": "int | None", + "description": "Total import volume (mt) of general-cargo ships on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_roro", + "type": "int | None", + "description": "Total import volume (mt) of Ro-Ro ships on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_tanker", + "type": "int | None", + "description": "Total import volume (mt) of tankers on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_container_30ma", + "type": "float | None", + "description": "30-day moving average of container import volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports_container_30ma_yoy_doy", + "type": "float | None", + "description": "Year-over-year change in the 30-day MA of container import volume, keyed on day of year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports", + "type": "int | None", + "description": "Total export volume (mt) of all ships departing on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_cargo", + "type": "int | None", + "description": "Total export volume (mt) of cargo ships (excluding tankers).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_container", + "type": "int | None", + "description": "Total export volume (mt) of container ships on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_dry_bulk", + "type": "int | None", + "description": "Total export volume (mt) of dry-bulk carriers on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_general_cargo", + "type": "int | None", + "description": "Total export volume (mt) of general-cargo ships on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_roro", + "type": "int | None", + "description": "Total export volume (mt) of Ro-Ro ships on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_tanker", + "type": "int | None", + "description": "Total export volume (mt) of tankers on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_container_30ma", + "type": "float | None", + "description": "30-day moving average of container export volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports_container_30ma_yoy_doy", + "type": "float | None", + "description": "Year-over-year change in the 30-day MA of container export volume, keyed on day of year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shipment", + "type": "int | None", + "description": "Total shipment volume (mt) crossing the country on this date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shipment_30ma", + "type": "float | None", + "description": "30-day moving average of total shipment volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shipment_30ma_yoy_doy", + "type": "float | None", + "description": "Year-over-year change in the 30-day MA of total shipment volume, keyed on day of year.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CountryActivity", + "openapi_extra": { + "model": "CountryActivity" + } + }, + "/imf/portwatch/monthly_trade": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly TradeNow trade-value, trade-volume, and AIS port-call series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Monthly TradeNow indices for the USA.\nobb.imf.portwatch.monthly_trade(code='USA', provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "code", + "type": "str | None", + "description": "ISO3 country code or IMF region code (e.g. 'USA', 'ASEAN-5').", + "default": "USA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/portwatch/list_tradenow_region_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "metric", + "type": "str | None", + "description": "TradeNow metric: 'trade_value', 'trade_volume', or 'portcalls'.", + "default": "trade_value", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "options": [ + { + "label": "Trade Value Index (2019=100)", + "value": "trade_value" + }, + { + "label": "Trade Volume Index (2019=100)", + "value": "trade_volume" + }, + { + "label": "AIS Port Calls", + "value": "portcalls" + } + ] + } + } + }, + { + "name": "start_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) lower bound for the monthly series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "end_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) upper bound for the monthly series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "theme", + "type": "str | None", + "description": "Theme for the chart. Only used when ``chart=True``.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "MonthlyTrade", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "imf": [ + { + "name": "date", + "type": "str | str", + "description": "Observation month (YYYY-MM-DD).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str", + "description": "ISO3 country or IMF region code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "IMF region label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_value", + "type": "float | None", + "description": "Trade value nowcast index (2019 = 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_volume", + "type": "float | None", + "description": "Trade volume nowcast index (2019 = 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value_import_total", + "type": "float | None", + "description": "Imports component of the trade value index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value_export_total", + "type": "float | None", + "description": "Exports component of the trade value index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_import_total", + "type": "float | None", + "description": "Imports component of the trade volume index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_export_total", + "type": "float | None", + "description": "Exports component of the trade volume index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_portcalls_container", + "type": "int | None", + "description": "Monthly AIS port calls by container ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_portcalls_dry_bulk", + "type": "int | None", + "description": "Monthly AIS port calls by dry-bulk carriers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_portcalls_general_cargo", + "type": "int | None", + "description": "Monthly AIS port calls by general-cargo ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_portcalls_roro", + "type": "int | None", + "description": "Monthly AIS port calls by Ro-Ro ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_portcalls_tanker", + "type": "int | None", + "description": "Monthly AIS port calls by tankers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_import_container", + "type": "int | None", + "description": "Monthly AIS import volume by container ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_import_dry_bulk", + "type": "int | None", + "description": "Monthly AIS import volume by dry-bulk carriers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_import_general_cargo", + "type": "int | None", + "description": "Monthly AIS import volume by general-cargo ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_import_roro", + "type": "int | None", + "description": "Monthly AIS import volume by Ro-Ro ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_import_tanker", + "type": "int | None", + "description": "Monthly AIS import volume by tankers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_export_container", + "type": "int | None", + "description": "Monthly AIS export volume by container ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_export_dry_bulk", + "type": "int | None", + "description": "Monthly AIS export volume by dry-bulk carriers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_export_general_cargo", + "type": "int | None", + "description": "Monthly AIS export volume by general-cargo ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_export_roro", + "type": "int | None", + "description": "Monthly AIS export volume by Ro-Ro ships.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ais_export_tanker", + "type": "int | None", + "description": "Monthly AIS export volume by tankers.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "MonthlyTrade", + "openapi_extra": { + "model": "MonthlyTrade" + } + }, + "/imf/portwatch/container_metrics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly container metrics by port (long format).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Top-10 container port calls.\nobb.imf.portwatch.container_metrics(metric='portcalls', provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "metric", + "type": "str | None", + "description": "Container metric to plot. Allowed: 'portcalls', 'import_container', 'export_container', 'incoming_cargo_container', 'outgoing_cargo_container'.", + "default": "portcalls", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "options": [ + { + "label": "Container Port Calls", + "value": "portcalls" + }, + { + "label": "Container Imports", + "value": "import_container" + }, + { + "label": "Container Exports", + "value": "export_container" + }, + { + "label": "Incoming Container Cargo", + "value": "incoming_cargo_container" + }, + { + "label": "Outgoing Container Cargo", + "value": "outgoing_cargo_container" + } + ] + } + } + }, + { + "name": "port_ids", + "type": "str | None | list[str | None]", + "description": "Comma- or plus-separated port IDs to compare, or 'TOP10' to auto-select the busiest ports for the chosen metric. Multiple items allowed.", + "default": "TOP10", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/portwatch/list_container_port_choices", + "multiSelect": true, + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "start_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) lower bound for the monthly series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "end_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) upper bound for the monthly series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "theme", + "type": "str | None", + "description": "Theme for the chart. Only used when ``chart=True``.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ContainerMetrics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "imf": [ + { + "name": "metric", + "type": "str", + "description": "Container metric name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "portid", + "type": "str", + "description": "Port identifier (e.g. PORT23).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "str | str", + "description": "Observation month (YYYY-MM-DD).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Metric value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ContainerMetrics", + "openapi_extra": { + "model": "ContainerMetrics" + } + }, + "/imf/portwatch/disruption_events": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Maritime disruption events with country / type / alert / date filters.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# All current disruption events.\nobb.imf.portwatch.disruption_events(provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "country", + "type": "str | None", + "description": "ISO3 country code to restrict the event list to.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/portwatch/list_country_choices", + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "alertlevel", + "type": "str | None", + "description": "Alert level filter: 'ALL', 'RED', 'ORANGE', or 'GREEN'.", + "default": "ALL", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "options": [ + { + "label": "All Alerts", + "value": "ALL" + }, + { + "label": "Red", + "value": "RED" + }, + { + "label": "Orange", + "value": "ORANGE" + }, + { + "label": "Green", + "value": "GREEN" + } + ] + } + } + }, + { + "name": "eventtype", + "type": "str | None", + "description": "Optional event-type filter (e.g. 'Cyclone', 'Conflict').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text" + } + } + }, + { + "name": "start_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) lower bound on the event start (fromdate).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "end_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) upper bound on the event start (fromdate).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "active_only", + "type": "bool | None", + "description": "If True, restrict to events whose end date is in the future or unset.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "boolean" + } + } + }, + { + "name": "theme", + "type": "str | None", + "description": "Theme for the map chart. Only used when ``chart=True``.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DisruptionEvents", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "imf": [ + { + "name": "eventid", + "type": "int", + "description": "Event identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eventname", + "type": "str", + "description": "Event name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eventtype", + "type": "str | None", + "description": "Event type (e.g. 'Conflict').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "alertlevel", + "type": "str | None", + "description": "Alert level (RED / ORANGE / GREEN).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "severitytext", + "type": "str | None", + "description": "Free-form severity description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "ISO3 country code of the affected event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fromdate", + "type": "str | None", + "description": "Event start date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "todate", + "type": "str | None", + "description": "Event end date (null if ongoing).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "editdate", + "type": "str | None", + "description": "Last update timestamp.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int | None", + "description": "Year of the event start.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "n_affectedports", + "type": "int | None", + "description": "Number of ports flagged as affected by this event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "affectedports", + "type": "str | None", + "description": "Comma-separated list of affected port IDs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "affectedpopulation", + "type": "str | None", + "description": "Estimated population of the affected area.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "Latitude of the event's centroid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "Longitude of the event's centroid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "html_name", + "type": "str | None", + "description": "Event name with embedded HTML for rich tooltips.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "html_description", + "type": "str | None", + "description": "Event description with embedded HTML.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "page_id", + "type": "str | None", + "description": "IMF Port Watch event-detail page identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "object_id", + "type": "int | None", + "description": "Internal ArcGIS feature row identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shape_area", + "type": "float | None", + "description": "Affected-area polygon area in projected units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shape_length", + "type": "float | None", + "description": "Affected-area polygon perimeter in projected units.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "DisruptionEvents", + "openapi_extra": { + "model": "DisruptionEvents" + } + }, + "/imf/portwatch/disruptions_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Disruption events surfaced as a Scattergeo chart when ``chart=True``.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Map of current disruption events.\nobb.imf.portwatch.disruptions_map(provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "country", + "type": "str | None", + "description": "ISO3 country code to restrict the event list to.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/portwatch/list_country_choices", + "style": { + "popupWidth": 350 + } + } + } + }, + { + "name": "alertlevel", + "type": "str | None", + "description": "Alert level filter: 'ALL', 'RED', 'ORANGE', or 'GREEN'.", + "default": "ALL", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "options": [ + { + "label": "All Alerts", + "value": "ALL" + }, + { + "label": "Red", + "value": "RED" + }, + { + "label": "Orange", + "value": "ORANGE" + }, + { + "label": "Green", + "value": "GREEN" + } + ] + } + } + }, + { + "name": "eventtype", + "type": "str | None", + "description": "Optional event-type filter (e.g. 'Cyclone', 'Conflict').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "text" + } + } + }, + { + "name": "start_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) lower bound on the event start (fromdate).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "end_date", + "type": "str | None", + "description": "ISO date (YYYY-MM-DD) upper bound on the event start (fromdate).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "date" + } + } + }, + { + "name": "active_only", + "type": "bool | None", + "description": "If True, restrict to events whose end date is in the future or unset.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "boolean" + } + } + }, + { + "name": "theme", + "type": "str | None", + "description": "Theme for the map chart. Only used when ``chart=True``.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DisruptionEvents", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "imf": [ + { + "name": "eventid", + "type": "int", + "description": "Event identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eventname", + "type": "str", + "description": "Event name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eventtype", + "type": "str | None", + "description": "Event type (e.g. 'Conflict').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "alertlevel", + "type": "str | None", + "description": "Alert level (RED / ORANGE / GREEN).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "severitytext", + "type": "str | None", + "description": "Free-form severity description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "ISO3 country code of the affected event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fromdate", + "type": "str | None", + "description": "Event start date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "todate", + "type": "str | None", + "description": "Event end date (null if ongoing).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "editdate", + "type": "str | None", + "description": "Last update timestamp.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int | None", + "description": "Year of the event start.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "n_affectedports", + "type": "int | None", + "description": "Number of ports flagged as affected by this event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "affectedports", + "type": "str | None", + "description": "Comma-separated list of affected port IDs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "affectedpopulation", + "type": "str | None", + "description": "Estimated population of the affected area.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latitude", + "type": "float | None", + "description": "Latitude of the event's centroid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "longitude", + "type": "float | None", + "description": "Longitude of the event's centroid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "html_name", + "type": "str | None", + "description": "Event name with embedded HTML for rich tooltips.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "html_description", + "type": "str | None", + "description": "Event description with embedded HTML.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "page_id", + "type": "str | None", + "description": "IMF Port Watch event-detail page identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "object_id", + "type": "int | None", + "description": "Internal ArcGIS feature row identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shape_area", + "type": "float | None", + "description": "Affected-area polygon area in projected units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shape_length", + "type": "float | None", + "description": "Affected-area polygon perimeter in projected units.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "DisruptionEvents", + "openapi_extra": { + "model": "DisruptionEvents" + } + }, + "/imf/portwatch/disruption_sankey": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Capacity-spillover Sankey edges for a single disruption event.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Sankey edges for the latest disruption event.\nobb.imf.portwatch.disruption_sankey(event_id='LATEST', provider='imf')\n```\n\n", + "parameters": { + "standard": [], + "imf": [ + { + "name": "event_id", + "type": "str | None", + "description": "Disruption event ID, or 'LATEST' for the most recent event.", + "default": "LATEST", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/imf/portwatch/list_disruption_event_choices", + "style": { + "popupWidth": 600 + } + } + } + }, + { + "name": "theme", + "type": "str | None", + "description": "Theme for the Sankey chart. Only used when ``chart=True``.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DisruptionSankey", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "imf": [ + { + "name": "eventid", + "type": "int", + "description": "Event identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "int", + "description": "Source node index in the Sankey diagram.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "target", + "type": "int", + "description": "Target node index in the Sankey diagram.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "source_port", + "type": "str", + "description": "Display label for the source port (e.g. 'Colombo (Sri Lanka)').", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "target_port", + "type": "str", + "description": "Display label for the destination port.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "source_port_id", + "type": "str | None", + "description": "IMF Port Watch port ID of the source.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_port_id", + "type": "str | None", + "description": "IMF Port Watch port ID of the destination.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source_country_code", + "type": "str | None", + "description": "ISO3 country code of the source port.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_country_code", + "type": "str | None", + "description": "ISO3 country code of the destination port.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "perc_disaster_capacity", + "type": "float | None", + "description": "Share (%) of the disrupted capacity rerouted along this edge.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "object_id", + "type": "int | None", + "description": "Internal ArcGIS feature row identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "DisruptionSankey", + "openapi_extra": { + "model": "DisruptionSankey" + } + }, + "/jodi/oil/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a country's monthly petroleum balance for one product - production, trade, stocks, and refinery activity, one column per flow of the JODI questionnaire.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the United States crude oil balance - one column per questionnaire flow.\nobb.jodi.oil.balance(provider='jodi')\n# Get India's gasoline balance, in thousand metric tons.\nobb.jodi.oil.balance(provider='jodi', country='india', product='gasoline', unit='ktons', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data for, by name or ISO 3166-1 alpha-2 code.", + "default": "united_states", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "The petroleum product to get the balance for. The first four are primary products, the rest are secondary products. JODI questionnaire definitions:\n crude_oil: Crude oil, including lease condensate and excluding NGL.\n ngl: Liquid or liquefied hydrocarbons recovered from gas separation plants and gas processing facilities.\n other_crude: Refinery feedstocks, additives/oxygenates, and other hydrocarbons.\n total_crude: The sum of the primary categories: crude oil + NGL + other.\n lpg: Liquefied petroleum gases, comprising propane and butane.\n naphtha: Naphtha used as feedstock for producing high octane gasoline and as feedstock for the chemical/petrochemical industries.\n gasoline: Motor gasoline and aviation gasoline; motor gasoline includes biogasoline, e.g. ethanol blends.\n kerosene: Kerosenes, comprising jet kerosene and other kerosene.\n jet_fuel: Kerosene type jet fuel: aviation fuel used for aviation turbine power units; a subset of the amount reported under kerosenes.\n gas_diesel_oil: Gas/diesel oil, for automotive and other purposes; biodiesel is included.\n fuel_oil: Heavy residual oil/boiler oil, including bunker oil.\n other_products: Refinery gas, ethane, petroleum coke, lubricants, white spirit and SBP, bitumen, paraffin waxes, and other petroleum products.\n total_products: The sum of all secondary product categories; demand for total products includes direct use of crude oil, NGL, and other hydrocarbons.", + "default": "crude_oil", + "optional": true, + "choices": [ + "crude_oil", + "ngl", + "other_crude", + "total_crude", + "lpg", + "naphtha", + "gasoline", + "kerosene", + "jet_fuel", + "gas_diesel_oil", + "fuel_oil", + "other_products", + "total_products" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbd", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilBalance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "production", + "type": "float | None", + "description": "Production (primary products). Marketed production, after removal of impurities but including quantities consumed by the producer in the production process.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "refinery_output", + "type": "float | None", + "description": "Refinery output (secondary products). Gross refinery output of finished products, including refinery fuel.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "from_other_sources", + "type": "float | None", + "description": "From other sources (primary products). Inputs of additives, biofuels, and other hydrocarbons produced from non-oil sources such as coal, natural gas, and renewable energy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receipts", + "type": "float | None", + "description": "Receipts (secondary products). Primary product receipts (quantities of oil used directly without processing in a refinery) plus recycled products. Receipts for other oil products include direct use of crude oil and NGL.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports", + "type": "float | None", + "description": "Imports. Goods having physically crossed the international boundaries, excluding transit trade and international marine and aviation bunkers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports", + "type": "float | None", + "description": "Exports. Goods having physically crossed the international boundaries, excluding transit trade and international marine and aviation bunkers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "products_transferred", + "type": "float | None", + "description": "Products transferred. For primary products, the sum of products transferred and backflows from the petrochemical industry; for secondary products, imported petroleum products reclassified as feedstocks for further processing in the refinery, without delivery to final consumers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interproduct_transfers", + "type": "float | None", + "description": "Interproduct transfers (secondary products). Reclassification of products because their specification has changed or because they are blended into another product; a negative entry indicates a product to be reclassified, a positive entry a reclassified product. Interproduct transfers for other oil products include interproduct transfers of crude oil and NGL.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_use", + "type": "float | None", + "description": "Direct use (primary products). Crude oil, NGL, and other hydrocarbons used directly without being processed in oil refineries, for example crude oil burned for electricity generation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_change", + "type": "float | None", + "description": "Stock change. Closing minus opening stock level; a positive number corresponds to a stock build, a negative number to a stock draw.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "statistical_difference", + "type": "float | None", + "description": "Statistical difference. Differences between observed supply flows and refinery intake or demand.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "refinery_intake", + "type": "float | None", + "description": "Refinery intake (primary products). Observed refinery throughputs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand", + "type": "float | None", + "description": "Demand (secondary products). Deliveries or sales to the inland market (domestic consumption) plus refinery fuel plus international marine and aviation bunkers. Demand for other oil products includes direct use of crude oil, NGL, and other primary hydrocarbons.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "closing_stocks", + "type": "float | None", + "description": "Closing stocks. The primary stock level at the end of the month within national territories; includes stocks held by importers, refiners, stock-holding organisations, and governments.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "JodiOilBalance", + "openapi_extra": { + "model": "JodiOilBalance" + } + }, + "/jodi/oil/production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly production of a primary petroleum product - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly crude oil production - one column per reporting country.\nobb.jodi.oil.production(provider='jodi')\n# Compare crude oil production in Saudi Arabia, Iraq, and the United States.\nobb.jodi.oil.production(provider='jodi', country='saudi_arabia,iraq,united_states', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "The primary petroleum product to get production of. JODI questionnaire definitions:\n crude_oil: Crude oil, including lease condensate and excluding NGL.\n ngl: Liquid or liquefied hydrocarbons recovered from gas separation plants and gas processing facilities.\n other_crude: Refinery feedstocks, additives/oxygenates, and other hydrocarbons.\n total_crude: The sum of the primary categories: crude oil + NGL + other.", + "default": "crude_oil", + "optional": true, + "choices": [ + "crude_oil", + "ngl", + "other_crude", + "total_crude" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbd", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiOilProduction", + "openapi_extra": { + "model": "JodiOilProduction" + } + }, + "/jodi/oil/demand": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly demand for a refined petroleum product - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly total petroleum products demand - one column per reporting country.\nobb.jodi.oil.demand(provider='jodi')\n# Compare gasoline demand in the United States, China, and India.\nobb.jodi.oil.demand(provider='jodi', country='united_states,china,india', product='gasoline', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "The refined petroleum product to get demand of. Demand is reported for secondary products only. JODI questionnaire definitions:\n lpg: Liquefied petroleum gases, comprising propane and butane.\n naphtha: Naphtha used as feedstock for producing high octane gasoline and as feedstock for the chemical/petrochemical industries.\n gasoline: Motor gasoline and aviation gasoline; motor gasoline includes biogasoline, e.g. ethanol blends.\n kerosene: Kerosenes, comprising jet kerosene and other kerosene.\n jet_fuel: Kerosene type jet fuel: aviation fuel used for aviation turbine power units; a subset of the amount reported under kerosenes.\n gas_diesel_oil: Gas/diesel oil, for automotive and other purposes; biodiesel is included.\n fuel_oil: Heavy residual oil/boiler oil, including bunker oil.\n other_products: Refinery gas, ethane, petroleum coke, lubricants, white spirit and SBP, bitumen, paraffin waxes, and other petroleum products.\n total_products: The sum of all secondary product categories; demand for total products includes direct use of crude oil, NGL, and other hydrocarbons.", + "default": "total_products", + "optional": true, + "choices": [ + "lpg", + "naphtha", + "gasoline", + "kerosene", + "jet_fuel", + "gas_diesel_oil", + "fuel_oil", + "other_products", + "total_products" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbd", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilDemand", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiOilDemand", + "openapi_extra": { + "model": "JodiOilDemand" + } + }, + "/jodi/oil/demand_by_product": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a country's monthly petroleum demand - one column per refined product, in published order.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly United States demand - one column per refined product.\nobb.jodi.oil.demand_by_product(provider='jodi')\n# Get Japan's demand barrel, in thousand barrels per day.\nobb.jodi.oil.demand_by_product(provider='jodi', country='japan', unit='kbd', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data for, by name or ISO 3166-1 alpha-2 code.", + "default": "united_states", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbd", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilDemandByProduct", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lpg", + "type": "float | None", + "description": "LPG demand. Liquefied petroleum gases, comprising propane and butane.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "naphtha", + "type": "float | None", + "description": "Naphtha demand. Naphtha used as feedstock for producing high octane gasoline and as feedstock for the chemical/petrochemical industries.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gasoline", + "type": "float | None", + "description": "Gasoline demand. Motor gasoline and aviation gasoline; motor gasoline includes biogasoline, e.g. ethanol blends.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "kerosene", + "type": "float | None", + "description": "Kerosenes demand. Kerosenes, comprising jet kerosene and other kerosene.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "jet_fuel", + "type": "float | None", + "description": "Jet fuel demand. Kerosene type jet fuel: aviation fuel used for aviation turbine power units; a subset of the amount reported under kerosenes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gas_diesel_oil", + "type": "float | None", + "description": "Gas/diesel oil demand. Gas/diesel oil, for automotive and other purposes; biodiesel is included.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel_oil", + "type": "float | None", + "description": "Fuel oil demand. Heavy residual oil/boiler oil, including bunker oil.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_products", + "type": "float | None", + "description": "Other oil products demand. Refinery gas, ethane, petroleum coke, lubricants, white spirit and SBP, bitumen, paraffin waxes, and other petroleum products. Includes direct use of crude oil, NGL, and other primary hydrocarbons.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_products", + "type": "float | None", + "description": "Total oil products demand. The sum of all secondary product categories; demand for total products includes direct use of crude oil, NGL, and other hydrocarbons.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "JodiOilDemandByProduct", + "openapi_extra": { + "model": "JodiOilDemandByProduct" + } + }, + "/jodi/oil/imports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly imports of a petroleum product - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly crude oil imports - one column per reporting country.\nobb.jodi.oil.imports(provider='jodi')\n# Compare crude oil imports of China, India, and South Korea.\nobb.jodi.oil.imports(provider='jodi', country='china,india,south_korea', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "The petroleum product to get imports of. JODI questionnaire definitions:\n crude_oil: Crude oil, including lease condensate and excluding NGL.\n ngl: Liquid or liquefied hydrocarbons recovered from gas separation plants and gas processing facilities.\n other_crude: Refinery feedstocks, additives/oxygenates, and other hydrocarbons.\n total_crude: The sum of the primary categories: crude oil + NGL + other.\n lpg: Liquefied petroleum gases, comprising propane and butane.\n naphtha: Naphtha used as feedstock for producing high octane gasoline and as feedstock for the chemical/petrochemical industries.\n gasoline: Motor gasoline and aviation gasoline; motor gasoline includes biogasoline, e.g. ethanol blends.\n kerosene: Kerosenes, comprising jet kerosene and other kerosene.\n jet_fuel: Kerosene type jet fuel: aviation fuel used for aviation turbine power units; a subset of the amount reported under kerosenes.\n gas_diesel_oil: Gas/diesel oil, for automotive and other purposes; biodiesel is included.\n fuel_oil: Heavy residual oil/boiler oil, including bunker oil.\n other_products: Refinery gas, ethane, petroleum coke, lubricants, white spirit and SBP, bitumen, paraffin waxes, and other petroleum products.\n total_products: The sum of all secondary product categories; demand for total products includes direct use of crude oil, NGL, and other hydrocarbons.", + "default": "crude_oil", + "optional": true, + "choices": [ + "crude_oil", + "ngl", + "other_crude", + "total_crude", + "lpg", + "naphtha", + "gasoline", + "kerosene", + "jet_fuel", + "gas_diesel_oil", + "fuel_oil", + "other_products", + "total_products" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbd", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilImports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiOilImports", + "openapi_extra": { + "model": "JodiOilImports" + } + }, + "/jodi/oil/exports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly exports of a petroleum product - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly crude oil exports - one column per reporting country.\nobb.jodi.oil.exports(provider='jodi')\n# Compare fuel oil exports from Russia and Saudi Arabia.\nobb.jodi.oil.exports(provider='jodi', country='russia,saudi_arabia', product='fuel_oil', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "The petroleum product to get exports of. JODI questionnaire definitions:\n crude_oil: Crude oil, including lease condensate and excluding NGL.\n ngl: Liquid or liquefied hydrocarbons recovered from gas separation plants and gas processing facilities.\n other_crude: Refinery feedstocks, additives/oxygenates, and other hydrocarbons.\n total_crude: The sum of the primary categories: crude oil + NGL + other.\n lpg: Liquefied petroleum gases, comprising propane and butane.\n naphtha: Naphtha used as feedstock for producing high octane gasoline and as feedstock for the chemical/petrochemical industries.\n gasoline: Motor gasoline and aviation gasoline; motor gasoline includes biogasoline, e.g. ethanol blends.\n kerosene: Kerosenes, comprising jet kerosene and other kerosene.\n jet_fuel: Kerosene type jet fuel: aviation fuel used for aviation turbine power units; a subset of the amount reported under kerosenes.\n gas_diesel_oil: Gas/diesel oil, for automotive and other purposes; biodiesel is included.\n fuel_oil: Heavy residual oil/boiler oil, including bunker oil.\n other_products: Refinery gas, ethane, petroleum coke, lubricants, white spirit and SBP, bitumen, paraffin waxes, and other petroleum products.\n total_products: The sum of all secondary product categories; demand for total products includes direct use of crude oil, NGL, and other hydrocarbons.", + "default": "crude_oil", + "optional": true, + "choices": [ + "crude_oil", + "ngl", + "other_crude", + "total_crude", + "lpg", + "naphtha", + "gasoline", + "kerosene", + "jet_fuel", + "gas_diesel_oil", + "fuel_oil", + "other_products", + "total_products" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbd", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilExports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiOilExports", + "openapi_extra": { + "model": "JodiOilExports" + } + }, + "/jodi/oil/stocks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly closing stock levels of a petroleum product - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly crude oil closing stock levels - one column per reporting country.\nobb.jodi.oil.stocks(provider='jodi')\n# Compare gasoline stocks in the United States and Japan, in thousand barrels.\nobb.jodi.oil.stocks(provider='jodi', country='united_states,japan', product='gasoline', unit='kbbl', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "The petroleum product to get closing stock levels of. JODI questionnaire definitions:\n crude_oil: Crude oil, including lease condensate and excluding NGL.\n ngl: Liquid or liquefied hydrocarbons recovered from gas separation plants and gas processing facilities.\n other_crude: Refinery feedstocks, additives/oxygenates, and other hydrocarbons.\n total_crude: The sum of the primary categories: crude oil + NGL + other.\n lpg: Liquefied petroleum gases, comprising propane and butane.\n naphtha: Naphtha used as feedstock for producing high octane gasoline and as feedstock for the chemical/petrochemical industries.\n gasoline: Motor gasoline and aviation gasoline; motor gasoline includes biogasoline, e.g. ethanol blends.\n kerosene: Kerosenes, comprising jet kerosene and other kerosene.\n jet_fuel: Kerosene type jet fuel: aviation fuel used for aviation turbine power units; a subset of the amount reported under kerosenes.\n gas_diesel_oil: Gas/diesel oil, for automotive and other purposes; biodiesel is included.\n fuel_oil: Heavy residual oil/boiler oil, including bunker oil.\n other_products: Refinery gas, ethane, petroleum coke, lubricants, white spirit and SBP, bitumen, paraffin waxes, and other petroleum products.\n total_products: The sum of all secondary product categories; demand for total products includes direct use of crude oil, NGL, and other hydrocarbons.", + "default": "crude_oil", + "optional": true, + "choices": [ + "crude_oil", + "ngl", + "other_crude", + "total_crude", + "lpg", + "naphtha", + "gasoline", + "kerosene", + "jet_fuel", + "gas_diesel_oil", + "fuel_oil", + "other_products", + "total_products" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. kbd: thousand barrels per day; kbbl: thousand barrels; kl: thousand kilolitres; ktons: thousand metric tons; conversion_factor: barrels per thousand metric tons.", + "default": "kbbl", + "optional": true, + "choices": [ + "kbd", + "kbbl", + "kl", + "ktons", + "conversion_factor" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2002-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiOilStocks", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiOilStocks", + "openapi_extra": { + "model": "JodiOilStocks" + } + }, + "/jodi/gas/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a country's monthly natural gas balance - production, pipeline and LNG trade, deliveries, and stocks, one column per flow of the JODI questionnaire.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the United States natural gas balance - one column per questionnaire flow.\nobb.jodi.gas.balance(provider='jodi')\n# Get Norway's natural gas balance, in terajoules.\nobb.jodi.gas.balance(provider='jodi', country='norway', unit='tj', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data for, by name or ISO 3166-1 alpha-2 code.", + "default": "united_states", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. m3: million cubic metres (at 15C, 760 mm Hg); tj: terajoules, on a gross calorific value basis; ktons: thousand metric tons, on a re-gasified equivalent basis, reported only for LNG trade amounts.", + "default": "m3", + "optional": true, + "choices": [ + "m3", + "tj", + "ktons" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2009-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiGasBalance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "production", + "type": "float | None", + "description": "Production. Dry marketable production within national boundaries, including offshore production, measured after purification and extraction of NGL and sulphur; excludes quantities reinjected, extraction losses, and quantities vented or flared; includes quantities used within the natural gas industry, in gas extraction, pipeline systems, and processing plants.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "from_other_sources", + "type": "float | None", + "description": "Receipts from other sources. Gas from energy products already accounted for in the production of other energy products, for example petroleum gases or biogases blended with natural gas.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "imports", + "type": "float | None", + "description": "Total imports. Amounts that have crossed the physical boundaries of the country, whether customs clearance has taken place or not; excludes goods in transit and goods temporarily admitted/withdrawn, includes re-imports; deliveries for international bunkers are excluded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pipeline_imports", + "type": "float | None", + "description": "Of which: pipeline imports. Imports of gaseous natural gas through pipelines.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lng_imports", + "type": "float | None", + "description": "Of which: LNG imports. Imports of liquefied natural gas through ocean tankers, on a re-gasified equivalent basis.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exports", + "type": "float | None", + "description": "Total exports. Amounts that have crossed the physical boundaries of the country, whether customs clearance has taken place or not; excludes goods in transit and goods temporarily admitted/withdrawn, includes re-exports; deliveries for international bunkers are excluded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pipeline_exports", + "type": "float | None", + "description": "Of which: pipeline exports. Exports of gaseous natural gas through pipelines.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lng_exports", + "type": "float | None", + "description": "Of which: LNG exports. Exports of liquefied natural gas through ocean tankers, on a re-gasified equivalent basis.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_change", + "type": "float | None", + "description": "Stock change. The difference between the closing and opening stock level of recoverable gas already extracted; a stock build is shown as a positive number, a stock draw as a negative number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand_calculated", + "type": "float | None", + "description": "Gross inland deliveries (calculated): production + receipts from other sources + imports - exports - stock change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "statistical_difference", + "type": "float | None", + "description": "Statistical difference. The difference between the calculated and observed gross inland deliveries.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "demand", + "type": "float | None", + "description": "Gross inland deliveries (observed): deliveries of marketable gas to the inland market, including gas used by the gas industry for heating and operation of equipment, losses in distribution, and deliveries to international marine and aviation bunkers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "electricity_and_heat_generation", + "type": "float | None", + "description": "Of which: electricity and heat generation. Deliveries of natural gas for the generation of electricity and heat in power plants, including both main-activity and autoproducer plants.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "closing_stocks", + "type": "float | None", + "description": "Closing stocks. The stock level held on the national territory on the last day of the reference month.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "JodiGasBalance", + "openapi_extra": { + "model": "JodiGasBalance" + } + }, + "/jodi/gas/production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly natural gas production - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly natural gas production - one column per reporting country.\nobb.jodi.gas.production(provider='jodi')\n# Compare natural gas production in the United States, Qatar, and Norway.\nobb.jodi.gas.production(provider='jodi', country='united_states,qatar,norway', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. m3: million cubic metres (at 15C, 760 mm Hg); tj: terajoules, on a gross calorific value basis; ktons: thousand metric tons, on a re-gasified equivalent basis, reported only for LNG trade amounts.", + "default": "m3", + "optional": true, + "choices": [ + "m3", + "tj", + "ktons" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2009-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiGasProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiGasProduction", + "openapi_extra": { + "model": "JodiGasProduction" + } + }, + "/jodi/gas/demand": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly natural gas demand, as gross inland deliveries - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly natural gas demand - one column per reporting country.\nobb.jodi.gas.demand(provider='jodi')\n# Compare natural gas demand in Germany, France, and Italy.\nobb.jodi.gas.demand(provider='jodi', country='germany,france,italy', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "The demand measure. JODI questionnaire definitions:\n observed: Gross inland deliveries (observed): deliveries of marketable gas to the inland market, including gas used by the gas industry for heating and operation of equipment, losses in distribution, and deliveries to international marine and aviation bunkers.\n calculated: Gross inland deliveries (calculated): production + receipts from other sources + imports - exports - stock change.", + "default": "observed", + "optional": true, + "choices": [ + "observed", + "calculated" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. m3: million cubic metres (at 15C, 760 mm Hg); tj: terajoules, on a gross calorific value basis; ktons: thousand metric tons, on a re-gasified equivalent basis, reported only for LNG trade amounts.", + "default": "m3", + "optional": true, + "choices": [ + "m3", + "tj", + "ktons" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2009-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiGasDemand", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiGasDemand", + "openapi_extra": { + "model": "JodiGasDemand" + } + }, + "/jodi/gas/imports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly natural gas imports - total, pipeline, or LNG - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly natural gas imports - one column per reporting country.\nobb.jodi.gas.imports(provider='jodi')\n# Compare LNG imports of Japan, China, and South Korea.\nobb.jodi.gas.imports(provider='jodi', country='japan,china,south_korea', flow='lng', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "flow", + "type": "str | None", + "description": "The imports breakdown. JODI questionnaire definitions:\n total: Amounts that have crossed the physical boundaries of the country, whether customs clearance has taken place or not; excludes goods in transit and goods temporarily admitted/withdrawn, includes re-imports; deliveries for international bunkers are excluded.\n pipeline: Imports of gaseous natural gas through pipelines.\n lng: Imports of liquefied natural gas through ocean tankers, on a re-gasified equivalent basis.", + "default": "total", + "optional": true, + "choices": [ + "total", + "pipeline", + "lng" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. m3: million cubic metres (at 15C, 760 mm Hg); tj: terajoules, on a gross calorific value basis; ktons: thousand metric tons, on a re-gasified equivalent basis, reported only for LNG trade amounts.", + "default": "m3", + "optional": true, + "choices": [ + "m3", + "tj", + "ktons" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2009-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiGasImports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiGasImports", + "openapi_extra": { + "model": "JodiGasImports" + } + }, + "/jodi/gas/exports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly natural gas exports - total, pipeline, or LNG - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly natural gas exports - one column per reporting country.\nobb.jodi.gas.exports(provider='jodi')\n# Compare LNG exports from the United States, Qatar, and Australia.\nobb.jodi.gas.exports(provider='jodi', country='united_states,qatar,australia', flow='lng', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "flow", + "type": "str | None", + "description": "The exports breakdown. JODI questionnaire definitions:\n total: Amounts that have crossed the physical boundaries of the country, whether customs clearance has taken place or not; excludes goods in transit and goods temporarily admitted/withdrawn, includes re-exports; deliveries for international bunkers are excluded.\n pipeline: Exports of gaseous natural gas through pipelines.\n lng: Exports of liquefied natural gas through ocean tankers, on a re-gasified equivalent basis.", + "default": "total", + "optional": true, + "choices": [ + "total", + "pipeline", + "lng" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. m3: million cubic metres (at 15C, 760 mm Hg); tj: terajoules, on a gross calorific value basis; ktons: thousand metric tons, on a re-gasified equivalent basis, reported only for LNG trade amounts.", + "default": "m3", + "optional": true, + "choices": [ + "m3", + "tj", + "ktons" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2009-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiGasExports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiGasExports", + "openapi_extra": { + "model": "JodiGasExports" + } + }, + "/jodi/gas/stocks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Monthly natural gas closing stock levels - one column per reporting country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get monthly natural gas closing stock levels - one column per reporting country.\nobb.jodi.gas.stocks(provider='jodi')\n# Compare natural gas stocks in Germany, France, and the Netherlands.\nobb.jodi.gas.stocks(provider='jodi', country='germany,france,netherlands', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [], + "jodi": [ + { + "name": "country", + "type": "str | None", + "description": "The country or countries to get data for, by name or ISO 3166-1 alpha-2 code. If None, all reporting countries are returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Albania", + "value": "albania" + }, + { + "label": "Algeria", + "value": "algeria" + }, + { + "label": "Angola", + "value": "angola" + }, + { + "label": "Argentina", + "value": "argentina" + }, + { + "label": "Armenia", + "value": "armenia" + }, + { + "label": "Australia", + "value": "australia" + }, + { + "label": "Austria", + "value": "austria" + }, + { + "label": "Azerbaijan", + "value": "azerbaijan" + }, + { + "label": "Bahrain", + "value": "bahrain" + }, + { + "label": "Bangladesh", + "value": "bangladesh" + }, + { + "label": "Barbados", + "value": "barbados" + }, + { + "label": "Belarus", + "value": "belarus" + }, + { + "label": "Belgium", + "value": "belgium" + }, + { + "label": "Belize", + "value": "belize" + }, + { + "label": "Bermuda", + "value": "bermuda" + }, + { + "label": "Bolivia", + "value": "bolivia" + }, + { + "label": "Brazil", + "value": "brazil" + }, + { + "label": "Brunei", + "value": "brunei" + }, + { + "label": "Bulgaria", + "value": "bulgaria" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Chile", + "value": "chile" + }, + { + "label": "China", + "value": "china" + }, + { + "label": "Colombia", + "value": "colombia" + }, + { + "label": "Costa Rica", + "value": "costa_rica" + }, + { + "label": "Croatia", + "value": "croatia" + }, + { + "label": "Cuba", + "value": "cuba" + }, + { + "label": "Cyprus", + "value": "cyprus" + }, + { + "label": "Czechia", + "value": "czechia" + }, + { + "label": "Denmark", + "value": "denmark" + }, + { + "label": "Dominican Republic", + "value": "dominican_republic" + }, + { + "label": "Ecuador", + "value": "ecuador" + }, + { + "label": "Egypt", + "value": "egypt" + }, + { + "label": "El Salvador", + "value": "el_salvador" + }, + { + "label": "Equatorial Guinea", + "value": "equatorial_guinea" + }, + { + "label": "Estonia", + "value": "estonia" + }, + { + "label": "Eswatini", + "value": "eswatini" + }, + { + "label": "Finland", + "value": "finland" + }, + { + "label": "France", + "value": "france" + }, + { + "label": "Gabon", + "value": "gabon" + }, + { + "label": "Gambia", + "value": "gambia" + }, + { + "label": "Georgia", + "value": "georgia" + }, + { + "label": "Germany", + "value": "germany" + }, + { + "label": "Greece", + "value": "greece" + }, + { + "label": "Grenada", + "value": "grenada" + }, + { + "label": "Guatemala", + "value": "guatemala" + }, + { + "label": "Guyana", + "value": "guyana" + }, + { + "label": "Haiti", + "value": "haiti" + }, + { + "label": "Honduras", + "value": "honduras" + }, + { + "label": "Hong Kong", + "value": "hong_kong" + }, + { + "label": "Hungary", + "value": "hungary" + }, + { + "label": "Iceland", + "value": "iceland" + }, + { + "label": "India", + "value": "india" + }, + { + "label": "Indonesia", + "value": "indonesia" + }, + { + "label": "Iran", + "value": "iran" + }, + { + "label": "Iraq", + "value": "iraq" + }, + { + "label": "Ireland", + "value": "ireland" + }, + { + "label": "Italy", + "value": "italy" + }, + { + "label": "Jamaica", + "value": "jamaica" + }, + { + "label": "Japan", + "value": "japan" + }, + { + "label": "Kazakhstan", + "value": "kazakhstan" + }, + { + "label": "Kuwait", + "value": "kuwait" + }, + { + "label": "Latvia", + "value": "latvia" + }, + { + "label": "Libya", + "value": "libya" + }, + { + "label": "Lithuania", + "value": "lithuania" + }, + { + "label": "Luxembourg", + "value": "luxembourg" + }, + { + "label": "Malaysia", + "value": "malaysia" + }, + { + "label": "Malta", + "value": "malta" + }, + { + "label": "Mauritius", + "value": "mauritius" + }, + { + "label": "Mexico", + "value": "mexico" + }, + { + "label": "Moldova", + "value": "moldova" + }, + { + "label": "Morocco", + "value": "morocco" + }, + { + "label": "Myanmar", + "value": "myanmar" + }, + { + "label": "Nepal", + "value": "nepal" + }, + { + "label": "Netherlands", + "value": "netherlands" + }, + { + "label": "New Zealand", + "value": "new_zealand" + }, + { + "label": "Nicaragua", + "value": "nicaragua" + }, + { + "label": "Niger", + "value": "niger" + }, + { + "label": "Nigeria", + "value": "nigeria" + }, + { + "label": "North Macedonia", + "value": "north_macedonia" + }, + { + "label": "Norway", + "value": "norway" + }, + { + "label": "Oman", + "value": "oman" + }, + { + "label": "Panama", + "value": "panama" + }, + { + "label": "Papua New Guinea", + "value": "papua_new_guinea" + }, + { + "label": "Paraguay", + "value": "paraguay" + }, + { + "label": "Peru", + "value": "peru" + }, + { + "label": "Philippines", + "value": "philippines" + }, + { + "label": "Poland", + "value": "poland" + }, + { + "label": "Portugal", + "value": "portugal" + }, + { + "label": "Qatar", + "value": "qatar" + }, + { + "label": "Romania", + "value": "romania" + }, + { + "label": "Russia", + "value": "russia" + }, + { + "label": "Saudi Arabia", + "value": "saudi_arabia" + }, + { + "label": "Serbia", + "value": "serbia" + }, + { + "label": "Singapore", + "value": "singapore" + }, + { + "label": "Slovakia", + "value": "slovakia" + }, + { + "label": "Slovenia", + "value": "slovenia" + }, + { + "label": "South Africa", + "value": "south_africa" + }, + { + "label": "South Korea", + "value": "south_korea" + }, + { + "label": "Spain", + "value": "spain" + }, + { + "label": "Sudan", + "value": "sudan" + }, + { + "label": "Suriname", + "value": "suriname" + }, + { + "label": "Sweden", + "value": "sweden" + }, + { + "label": "Switzerland", + "value": "switzerland" + }, + { + "label": "Syria", + "value": "syria" + }, + { + "label": "Taiwan", + "value": "taiwan" + }, + { + "label": "Tajikistan", + "value": "tajikistan" + }, + { + "label": "Thailand", + "value": "thailand" + }, + { + "label": "Trinidad and Tobago", + "value": "trinidad_and_tobago" + }, + { + "label": "Tunisia", + "value": "tunisia" + }, + { + "label": "Turkiye", + "value": "turkiye" + }, + { + "label": "Ukraine", + "value": "ukraine" + }, + { + "label": "United Arab Emirates", + "value": "united_arab_emirates" + }, + { + "label": "United Kingdom", + "value": "united_kingdom" + }, + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Uruguay", + "value": "uruguay" + }, + { + "label": "Venezuela", + "value": "venezuela" + }, + { + "label": "Vietnam", + "value": "vietnam" + }, + { + "label": "Yemen", + "value": "yemen" + } + ], + "style": { + "popupWidth": 450 + } + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement. m3: million cubic metres (at 15C, 760 mm Hg); tj: terajoules, on a gross calorific value basis; ktons: thousand metric tons, on a re-gasified equivalent basis, reported only for LNG trade amounts.", + "default": "m3", + "optional": true, + "choices": [ + "m3", + "tj", + "ktons" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Defaults to the first data period, 2009-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "If True, the source tables are cached under the user cache directory and revalidated against the source at most once per day, downloading again only when JODI has published an update.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "JodiGasStocks", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "jodi": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "albania", + "type": "float | None", + "description": "Monthly value reported by Albania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Albania" + } + } + }, + { + "name": "algeria", + "type": "float | None", + "description": "Monthly value reported by Algeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Algeria" + } + } + }, + { + "name": "angola", + "type": "float | None", + "description": "Monthly value reported by Angola.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Angola" + } + } + }, + { + "name": "argentina", + "type": "float | None", + "description": "Monthly value reported by Argentina.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Argentina" + } + } + }, + { + "name": "armenia", + "type": "float | None", + "description": "Monthly value reported by Armenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Armenia" + } + } + }, + { + "name": "australia", + "type": "float | None", + "description": "Monthly value reported by Australia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Australia" + } + } + }, + { + "name": "austria", + "type": "float | None", + "description": "Monthly value reported by Austria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Austria" + } + } + }, + { + "name": "azerbaijan", + "type": "float | None", + "description": "Monthly value reported by Azerbaijan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Azerbaijan" + } + } + }, + { + "name": "bahrain", + "type": "float | None", + "description": "Monthly value reported by Bahrain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bahrain" + } + } + }, + { + "name": "bangladesh", + "type": "float | None", + "description": "Monthly value reported by Bangladesh.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bangladesh" + } + } + }, + { + "name": "barbados", + "type": "float | None", + "description": "Monthly value reported by Barbados.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Barbados" + } + } + }, + { + "name": "belarus", + "type": "float | None", + "description": "Monthly value reported by Belarus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belarus" + } + } + }, + { + "name": "belgium", + "type": "float | None", + "description": "Monthly value reported by Belgium.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belgium" + } + } + }, + { + "name": "belize", + "type": "float | None", + "description": "Monthly value reported by Belize.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Belize" + } + } + }, + { + "name": "bermuda", + "type": "float | None", + "description": "Monthly value reported by Bermuda.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bermuda" + } + } + }, + { + "name": "bolivia", + "type": "float | None", + "description": "Monthly value reported by Bolivia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bolivia" + } + } + }, + { + "name": "brazil", + "type": "float | None", + "description": "Monthly value reported by Brazil.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brazil" + } + } + }, + { + "name": "brunei", + "type": "float | None", + "description": "Monthly value reported by Brunei.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Brunei" + } + } + }, + { + "name": "bulgaria", + "type": "float | None", + "description": "Monthly value reported by Bulgaria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bulgaria" + } + } + }, + { + "name": "canada", + "type": "float | None", + "description": "Monthly value reported by Canada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Canada" + } + } + }, + { + "name": "chile", + "type": "float | None", + "description": "Monthly value reported by Chile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chile" + } + } + }, + { + "name": "china", + "type": "float | None", + "description": "Monthly value reported by China.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "China" + } + } + }, + { + "name": "colombia", + "type": "float | None", + "description": "Monthly value reported by Colombia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Colombia" + } + } + }, + { + "name": "costa_rica", + "type": "float | None", + "description": "Monthly value reported by Costa Rica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Costa Rica" + } + } + }, + { + "name": "croatia", + "type": "float | None", + "description": "Monthly value reported by Croatia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Croatia" + } + } + }, + { + "name": "cuba", + "type": "float | None", + "description": "Monthly value reported by Cuba.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cuba" + } + } + }, + { + "name": "cyprus", + "type": "float | None", + "description": "Monthly value reported by Cyprus.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cyprus" + } + } + }, + { + "name": "czechia", + "type": "float | None", + "description": "Monthly value reported by Czechia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Czechia" + } + } + }, + { + "name": "denmark", + "type": "float | None", + "description": "Monthly value reported by Denmark.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Denmark" + } + } + }, + { + "name": "dominican_republic", + "type": "float | None", + "description": "Monthly value reported by Dominican Republic.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dominican Republic" + } + } + }, + { + "name": "ecuador", + "type": "float | None", + "description": "Monthly value reported by Ecuador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ecuador" + } + } + }, + { + "name": "egypt", + "type": "float | None", + "description": "Monthly value reported by Egypt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Egypt" + } + } + }, + { + "name": "el_salvador", + "type": "float | None", + "description": "Monthly value reported by El Salvador.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "El Salvador" + } + } + }, + { + "name": "equatorial_guinea", + "type": "float | None", + "description": "Monthly value reported by Equatorial Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Equatorial Guinea" + } + } + }, + { + "name": "estonia", + "type": "float | None", + "description": "Monthly value reported by Estonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Estonia" + } + } + }, + { + "name": "eswatini", + "type": "float | None", + "description": "Monthly value reported by Eswatini.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Eswatini" + } + } + }, + { + "name": "finland", + "type": "float | None", + "description": "Monthly value reported by Finland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Finland" + } + } + }, + { + "name": "france", + "type": "float | None", + "description": "Monthly value reported by France.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "France" + } + } + }, + { + "name": "gabon", + "type": "float | None", + "description": "Monthly value reported by Gabon.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gabon" + } + } + }, + { + "name": "gambia", + "type": "float | None", + "description": "Monthly value reported by Gambia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Gambia" + } + } + }, + { + "name": "georgia", + "type": "float | None", + "description": "Monthly value reported by Georgia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Georgia" + } + } + }, + { + "name": "germany", + "type": "float | None", + "description": "Monthly value reported by Germany.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Germany" + } + } + }, + { + "name": "greece", + "type": "float | None", + "description": "Monthly value reported by Greece.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Greece" + } + } + }, + { + "name": "grenada", + "type": "float | None", + "description": "Monthly value reported by Grenada.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grenada" + } + } + }, + { + "name": "guatemala", + "type": "float | None", + "description": "Monthly value reported by Guatemala.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guatemala" + } + } + }, + { + "name": "guyana", + "type": "float | None", + "description": "Monthly value reported by Guyana.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Guyana" + } + } + }, + { + "name": "haiti", + "type": "float | None", + "description": "Monthly value reported by Haiti.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Haiti" + } + } + }, + { + "name": "honduras", + "type": "float | None", + "description": "Monthly value reported by Honduras.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Honduras" + } + } + }, + { + "name": "hong_kong", + "type": "float | None", + "description": "Monthly value reported by Hong Kong.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hong Kong" + } + } + }, + { + "name": "hungary", + "type": "float | None", + "description": "Monthly value reported by Hungary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Hungary" + } + } + }, + { + "name": "iceland", + "type": "float | None", + "description": "Monthly value reported by Iceland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iceland" + } + } + }, + { + "name": "india", + "type": "float | None", + "description": "Monthly value reported by India.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "India" + } + } + }, + { + "name": "indonesia", + "type": "float | None", + "description": "Monthly value reported by Indonesia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Indonesia" + } + } + }, + { + "name": "iran", + "type": "float | None", + "description": "Monthly value reported by Iran.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iran" + } + } + }, + { + "name": "iraq", + "type": "float | None", + "description": "Monthly value reported by Iraq.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Iraq" + } + } + }, + { + "name": "ireland", + "type": "float | None", + "description": "Monthly value reported by Ireland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ireland" + } + } + }, + { + "name": "italy", + "type": "float | None", + "description": "Monthly value reported by Italy.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Italy" + } + } + }, + { + "name": "jamaica", + "type": "float | None", + "description": "Monthly value reported by Jamaica.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jamaica" + } + } + }, + { + "name": "japan", + "type": "float | None", + "description": "Monthly value reported by Japan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Japan" + } + } + }, + { + "name": "kazakhstan", + "type": "float | None", + "description": "Monthly value reported by Kazakhstan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kazakhstan" + } + } + }, + { + "name": "kuwait", + "type": "float | None", + "description": "Monthly value reported by Kuwait.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Kuwait" + } + } + }, + { + "name": "latvia", + "type": "float | None", + "description": "Monthly value reported by Latvia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Latvia" + } + } + }, + { + "name": "libya", + "type": "float | None", + "description": "Monthly value reported by Libya.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Libya" + } + } + }, + { + "name": "lithuania", + "type": "float | None", + "description": "Monthly value reported by Lithuania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Lithuania" + } + } + }, + { + "name": "luxembourg", + "type": "float | None", + "description": "Monthly value reported by Luxembourg.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Luxembourg" + } + } + }, + { + "name": "malaysia", + "type": "float | None", + "description": "Monthly value reported by Malaysia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malaysia" + } + } + }, + { + "name": "malta", + "type": "float | None", + "description": "Monthly value reported by Malta.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Malta" + } + } + }, + { + "name": "mauritius", + "type": "float | None", + "description": "Monthly value reported by Mauritius.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mauritius" + } + } + }, + { + "name": "mexico", + "type": "float | None", + "description": "Monthly value reported by Mexico.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mexico" + } + } + }, + { + "name": "moldova", + "type": "float | None", + "description": "Monthly value reported by Moldova.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Moldova" + } + } + }, + { + "name": "morocco", + "type": "float | None", + "description": "Monthly value reported by Morocco.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Morocco" + } + } + }, + { + "name": "myanmar", + "type": "float | None", + "description": "Monthly value reported by Myanmar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Myanmar" + } + } + }, + { + "name": "nepal", + "type": "float | None", + "description": "Monthly value reported by Nepal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nepal" + } + } + }, + { + "name": "netherlands", + "type": "float | None", + "description": "Monthly value reported by Netherlands.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Netherlands" + } + } + }, + { + "name": "new_zealand", + "type": "float | None", + "description": "Monthly value reported by New Zealand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New Zealand" + } + } + }, + { + "name": "nicaragua", + "type": "float | None", + "description": "Monthly value reported by Nicaragua.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nicaragua" + } + } + }, + { + "name": "niger", + "type": "float | None", + "description": "Monthly value reported by Niger.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Niger" + } + } + }, + { + "name": "nigeria", + "type": "float | None", + "description": "Monthly value reported by Nigeria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nigeria" + } + } + }, + { + "name": "north_macedonia", + "type": "float | None", + "description": "Monthly value reported by North Macedonia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "North Macedonia" + } + } + }, + { + "name": "norway", + "type": "float | None", + "description": "Monthly value reported by Norway.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Norway" + } + } + }, + { + "name": "oman", + "type": "float | None", + "description": "Monthly value reported by Oman.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Oman" + } + } + }, + { + "name": "panama", + "type": "float | None", + "description": "Monthly value reported by Panama.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Panama" + } + } + }, + { + "name": "papua_new_guinea", + "type": "float | None", + "description": "Monthly value reported by Papua New Guinea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Papua New Guinea" + } + } + }, + { + "name": "paraguay", + "type": "float | None", + "description": "Monthly value reported by Paraguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Paraguay" + } + } + }, + { + "name": "peru", + "type": "float | None", + "description": "Monthly value reported by Peru.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Peru" + } + } + }, + { + "name": "philippines", + "type": "float | None", + "description": "Monthly value reported by Philippines.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philippines" + } + } + }, + { + "name": "poland", + "type": "float | None", + "description": "Monthly value reported by Poland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Poland" + } + } + }, + { + "name": "portugal", + "type": "float | None", + "description": "Monthly value reported by Portugal.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Portugal" + } + } + }, + { + "name": "qatar", + "type": "float | None", + "description": "Monthly value reported by Qatar.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Qatar" + } + } + }, + { + "name": "romania", + "type": "float | None", + "description": "Monthly value reported by Romania.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Romania" + } + } + }, + { + "name": "russia", + "type": "float | None", + "description": "Monthly value reported by Russia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Russia" + } + } + }, + { + "name": "saudi_arabia", + "type": "float | None", + "description": "Monthly value reported by Saudi Arabia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Saudi Arabia" + } + } + }, + { + "name": "serbia", + "type": "float | None", + "description": "Monthly value reported by Serbia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Serbia" + } + } + }, + { + "name": "singapore", + "type": "float | None", + "description": "Monthly value reported by Singapore.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Singapore" + } + } + }, + { + "name": "slovakia", + "type": "float | None", + "description": "Monthly value reported by Slovakia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovakia" + } + } + }, + { + "name": "slovenia", + "type": "float | None", + "description": "Monthly value reported by Slovenia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Slovenia" + } + } + }, + { + "name": "south_africa", + "type": "float | None", + "description": "Monthly value reported by South Africa.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Africa" + } + } + }, + { + "name": "south_korea", + "type": "float | None", + "description": "Monthly value reported by South Korea.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South Korea" + } + } + }, + { + "name": "spain", + "type": "float | None", + "description": "Monthly value reported by Spain.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spain" + } + } + }, + { + "name": "sudan", + "type": "float | None", + "description": "Monthly value reported by Sudan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sudan" + } + } + }, + { + "name": "suriname", + "type": "float | None", + "description": "Monthly value reported by Suriname.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Suriname" + } + } + }, + { + "name": "sweden", + "type": "float | None", + "description": "Monthly value reported by Sweden.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sweden" + } + } + }, + { + "name": "switzerland", + "type": "float | None", + "description": "Monthly value reported by Switzerland.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Switzerland" + } + } + }, + { + "name": "syria", + "type": "float | None", + "description": "Monthly value reported by Syria.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Syria" + } + } + }, + { + "name": "taiwan", + "type": "float | None", + "description": "Monthly value reported by Taiwan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Taiwan" + } + } + }, + { + "name": "tajikistan", + "type": "float | None", + "description": "Monthly value reported by Tajikistan.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tajikistan" + } + } + }, + { + "name": "thailand", + "type": "float | None", + "description": "Monthly value reported by Thailand.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Thailand" + } + } + }, + { + "name": "trinidad_and_tobago", + "type": "float | None", + "description": "Monthly value reported by Trinidad and Tobago.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Trinidad and Tobago" + } + } + }, + { + "name": "tunisia", + "type": "float | None", + "description": "Monthly value reported by Tunisia.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tunisia" + } + } + }, + { + "name": "turkiye", + "type": "float | None", + "description": "Monthly value reported by Turkiye.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Turkiye" + } + } + }, + { + "name": "ukraine", + "type": "float | None", + "description": "Monthly value reported by Ukraine.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Ukraine" + } + } + }, + { + "name": "united_arab_emirates", + "type": "float | None", + "description": "Monthly value reported by United Arab Emirates.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Arab Emirates" + } + } + }, + { + "name": "united_kingdom", + "type": "float | None", + "description": "Monthly value reported by United Kingdom.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United Kingdom" + } + } + }, + { + "name": "united_states", + "type": "float | None", + "description": "Monthly value reported by United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "United States" + } + } + }, + { + "name": "uruguay", + "type": "float | None", + "description": "Monthly value reported by Uruguay.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uruguay" + } + } + }, + { + "name": "venezuela", + "type": "float | None", + "description": "Monthly value reported by Venezuela.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Venezuela" + } + } + }, + { + "name": "vietnam", + "type": "float | None", + "description": "Monthly value reported by Vietnam.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vietnam" + } + } + }, + { + "name": "yemen", + "type": "float | None", + "description": "Monthly value reported by Yemen.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Yemen" + } + } + } + ] + }, + "model": "JodiGasStocks", + "openapi_extra": { + "model": "JodiGasStocks" + } + }, + "/nasdaq/equity/symbol_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every operating company Nasdaq lists.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the Nasdaq-traded symbol directory.\n >>> obb.nasdaq.equity.symbol_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the Nasdaq-traded symbol directory.\nobb.nasdaq.equity.symbol_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/nasdaq/equity/document_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of filing PDFs for a symbol, year, and form group.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the filing documents available for a symbol.\nobb.nasdaq.equity.document_choices(symbol='AAPL', year=2026, form_group='8k')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": true + }, + { + "name": "year", + "type": "int", + "description": "The calendar year of the filings.", + "default": null, + "optional": true + }, + { + "name": "form_group", + "type": "str", + "description": "The SEC form group.", + "default": "8k", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/nasdaq/equity/filings_viewer": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open the selected SEC filing PDFs for the OpenBB Workspace file viewer.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "params", + "type": "dict", + "description": "", + "default": null, + "optional": false + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "type": "multi_file_viewer", + "name": "Nasdaq SEC Filings", + "description": "View SEC filings by company.", + "category": "Equity", + "subCategory": "Filings", + "refetchInterval": false, + "gridData": { + "w": 40, + "h": 30 + }, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "description": "Ticker symbol for the company. Foreign (dual-listed) companies may not be required to file with the SEC.", + "type": "endpoint", + "value": "AAPL", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + }, + { + "paramName": "document_url", + "label": "Document URL", + "description": "Select the document to open.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/document_choices", + "optionsParams": { + "symbol": "$symbol", + "year": "$year", + "form_group": "$form_group" + }, + "show": false, + "roles": [ + "fileSelector" + ], + "multiSelect": true + }, + { + "paramName": "year", + "label": "Calendar Year", + "description": "Calendar year for the filings.", + "type": "number", + "optionsEndpoint": "/api/v1/nasdaq/equity/filing_years" + }, + { + "paramName": "form_group", + "label": "Form Group", + "description": "Form group for the filings.", + "value": "8k", + "type": "text", + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarterly", + "value": "quarterly" + }, + { + "label": "Proxy", + "value": "proxy" + }, + { + "label": "Insider", + "value": "insider" + }, + { + "label": "8-K", + "value": "8k" + }, + { + "label": "Registration", + "value": "registration" + }, + { + "label": "Comment", + "value": "comment" + } + ] + } + ] + }, + "model": "" + } + }, + "/nasdaq/equity/filing_years": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of the calendar years Nasdaq indexes filings for.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the selectable filing years.\n >>> obb.nasdaq.equity.filing_years()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the selectable filing years.\nobb.nasdaq.equity.filing_years()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/nasdaq/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the Nasdaq symbol directory.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the Nasdaq-traded symbol directory.\nobb.nasdaq.equity.search(query='apple', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "is_etf", + "type": "bool | None", + "description": "If True, returns only ETFs.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEquitySearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "nasdaq_traded", + "type": "str | None", + "description": "Is Nasdaq traded?", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Primary Exchange", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_category", + "type": "str | None", + "description": "Market Category", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "etf", + "type": "str | None", + "description": "Is ETF?", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "round_lot_size", + "type": "float | None", + "description": "Round Lot Size", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "test_issue", + "type": "str | None", + "description": "Is test Issue?", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_status", + "type": "str | None", + "description": "Financial Status", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cqs_symbol", + "type": "str | None", + "description": "CQS Symbol", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nasdaq_symbol", + "type": "str | None", + "description": "NASDAQ Symbol", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "next_shares", + "type": "str | None", + "description": "Is NextShares?", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEquitySearch", + "openapi_extra": { + "model": "NasdaqEquitySearch" + } + }, + "/nasdaq/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen US-listed equities by exchange, sector, region, and market cap.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Screen the full Nasdaq-listed universe.\nobb.nasdaq.equity.screener(exchange='nasdaq', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "exchange", + "type": "str | None | list[str | None]", + "description": "Filter by exchange. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "nasdaq", + "nyse", + "amex" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "exsubcategory", + "type": "str | None | list[str | None]", + "description": "Filter by exchange subcategory.\n- NGS - Nasdaq Global Select Market\n- NGM - Nasdaq Global Market\n- NCM - Nasdaq Capital Market\n- ADR - American Depository Receipt Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "ngs", + "ngm", + "ncm", + "adr" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "mktcap", + "type": "str | None | list[str | None]", + "description": "Filter by market cap.\n- Mega - > 200B\n- Large - 10B - 200B\n- Mid - 2B - 10B\n- Small - 300M - 2B\n- Micro - 50M - 300M Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "mega", + "large", + "mid", + "small", + "micro" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "recommendation", + "type": "str | None | list[str | None]", + "description": "Filter by consensus analyst action. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "strong_buy", + "buy", + "hold", + "sell", + "strong_sell" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None | list[str | None]", + "description": "Filter by sector. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "energy", + "basic_materials", + "industrials", + "consumer_staples", + "consumer_discretionary", + "health_care", + "financial_services", + "technology", + "communication_services", + "utilities", + "real_estate" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None | list[str | None]", + "description": "Filter by region. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "africa", + "asia", + "australia_and_south_pacific", + "caribbean", + "europe", + "middle_east", + "north_america", + "south_america" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "Filter by country. Accepts country names, ISO 3166-1 alpha-2/alpha-3 codes, or 'all' for all countries. Multiple comma-separated values allowed. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "all", + "argentina", + "armenia", + "australia", + "austria", + "belgium", + "bermuda", + "brazil", + "canada", + "cayman_islands", + "chile", + "colombia", + "costa_rica", + "curacao", + "cyprus", + "denmark", + "finland", + "france", + "germany", + "greece", + "guernsey", + "hong_kong", + "india", + "indonesia", + "ireland", + "isle_of_man", + "israel", + "italy", + "japan", + "jersey", + "luxembourg", + "macau", + "mexico", + "monaco", + "netherlands", + "norway", + "panama", + "peru", + "philippines", + "puerto_rico", + "russia", + "singapore", + "south_africa", + "south_korea", + "spain", + "sweden", + "switzerland", + "taiwan", + "turkey", + "united_kingdom", + "united_states", + "usa" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of results to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEquityScreener", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "last_price", + "type": "float", + "description": "Last sale price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "float | None", + "description": "1-day change in price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change_percent", + "type": "float | None", + "description": "1-day percent change in price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "market_cap", + "type": "float | None", + "description": "Market cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The last session's share volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country the company is domiciled in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ipo_year", + "type": "int | None", + "description": "The year the company listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry", + "type": "str | None", + "description": "The industry of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The sector of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEquityScreener", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqEquityScreener" + } + }, + "/nasdaq/equity/quote": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Delayed Nasdaq quotes, with the sector, market cap, and dividend summary.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Delayed quote with the Nasdaq summary block.\nobb.nasdaq.equity.quote(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEquityQuote", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company or asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "Price of the top bid order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "str | None", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "Price of the top ask order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "str | None", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_indicators", + "type": "int | list[int] | list[str] | str | None", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sequence_number", + "type": "int | None", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_center", + "type": "str | None", + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "participant_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trf_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sip_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "Price of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_tick", + "type": "str | None", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_size", + "type": "int | None", + "description": "Size of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_timestamp", + "type": "datetime | None", + "description": "Date and Time when the last price was recorded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_volume", + "type": "float | int | None", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price from previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "The one year high (52W High).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The one year low (52W Low).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "name", + "type": "str | None", + "description": "The name of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the security trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The sector of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry", + "type": "str | None", + "description": "The industry of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market capitalization of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_volume", + "type": "float | None", + "description": "The average daily share volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_target", + "type": "float | None", + "description": "The one-year analyst price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annualized_dividend", + "type": "float | None", + "description": "The annualized dividend amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "The current dividend yield, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ex_dividend_date", + "type": "date | None", + "description": "The most recent ex-dividend date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_payment_date", + "type": "date | None", + "description": "The most recent dividend payment date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_nasdaq_100", + "type": "bool | None", + "description": "Whether the security is a Nasdaq-100 constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_status", + "type": "str | None", + "description": "The market session status at capture.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEquityQuote", + "openapi_extra": { + "model": "NasdaqEquityQuote" + } + }, + "/nasdaq/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company profile, sector, industry, and business description.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The company profile.\nobb.nasdaq.equity.profile(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEquityInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Common name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legal_name", + "type": "str | None", + "description": "Official legal name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_exchange", + "type": "str | None", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sic", + "type": "int | None", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_description", + "type": "str | None", + "description": "Short description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_description", + "type": "str | None", + "description": "Long description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ceo", + "type": "str | None", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_url", + "type": "str | None", + "description": "URL of the company's website.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_address", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mailing_address", + "type": "str | None", + "description": "Mailing address of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_phone_no", + "type": "str | None", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address1", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address2", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_city", + "type": "str | None", + "description": "City of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_postal_code", + "type": "str | None", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_state", + "type": "str | None", + "description": "State of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_country", + "type": "str | None", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_state", + "type": "str | None", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_country", + "type": "str | None", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employees", + "type": "int | None", + "description": "Number of employees working for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_legal_form", + "type": "str | None", + "description": "Legal form of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_status", + "type": "str | None", + "description": "Status of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_filing_date", + "type": "date | None", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "irs_number", + "type": "str | None", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_category", + "type": "str | None", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "template", + "type": "str | None", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standardized_active", + "type": "bool | None", + "description": "Whether the company is active or not.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_fundamental_date", + "type": "date | None", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_fundamental_date", + "type": "date | None", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_stock_price_date", + "type": "date | None", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_stock_price_date", + "type": "date | None", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "region", + "type": "str | None", + "description": "The region the company is domiciled in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the security trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_type", + "type": "str | None", + "description": "The type of security - i.e., Common Stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_nasdaq_100", + "type": "bool | None", + "description": "Whether the security is a Nasdaq-100 constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEquityInfo", + "openapi_extra": { + "model": "NasdaqEquityInfo" + } + }, + "/nasdaq/equity/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily OHLCV history for Nasdaq-quoted equities.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily historical prices.\nobb.nasdaq.equity.historical(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEquityHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol, when more than one is requested.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEquityHistorical", + "openapi_extra": { + "model": "NasdaqEquityHistorical" + } + }, + "/nasdaq/equity/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "SEC filings for a company, with links to the filed PDFs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# SEC filings indexed by Nasdaq.\nobb.nasdaq.equity.filings(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "value": "AAPL" + } + } + } + } + ], + "nasdaq": [ + { + "name": "year", + "type": "int | None", + "description": "Calendar year of the data, default is current year. The earliest year available is 1994, for all companies and form types.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "2026", + "value": 2026 + }, + { + "label": "2025", + "value": 2025 + }, + { + "label": "2024", + "value": 2024 + }, + { + "label": "2023", + "value": 2023 + }, + { + "label": "2022", + "value": 2022 + }, + { + "label": "2021", + "value": 2021 + }, + { + "label": "2020", + "value": 2020 + }, + { + "label": "2019", + "value": 2019 + }, + { + "label": "2018", + "value": 2018 + }, + { + "label": "2017", + "value": 2017 + }, + { + "label": "2016", + "value": 2016 + }, + { + "label": "2015", + "value": 2015 + }, + { + "label": "2014", + "value": 2014 + }, + { + "label": "2013", + "value": 2013 + }, + { + "label": "2012", + "value": 2012 + }, + { + "label": "2011", + "value": 2011 + }, + { + "label": "2010", + "value": 2010 + }, + { + "label": "2009", + "value": 2009 + }, + { + "label": "2008", + "value": 2008 + }, + { + "label": "2007", + "value": 2007 + }, + { + "label": "2006", + "value": 2006 + }, + { + "label": "2005", + "value": 2005 + }, + { + "label": "2004", + "value": 2004 + }, + { + "label": "2003", + "value": 2003 + }, + { + "label": "2002", + "value": 2002 + }, + { + "label": "2001", + "value": 2001 + }, + { + "label": "2000", + "value": 2000 + }, + { + "label": "1999", + "value": 1999 + }, + { + "label": "1998", + "value": 1998 + }, + { + "label": "1997", + "value": 1997 + }, + { + "label": "1996", + "value": 1996 + }, + { + "label": "1995", + "value": 1995 + }, + { + "label": "1994", + "value": 1994 + } + ], + "value": 2026 + } + } + }, + { + "name": "form_group", + "type": "str | None", + "description": "The form group to fetch, default is 8k.", + "default": "8k", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCompanyFilings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "Type of filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "period_ending", + "type": "date | None", + "description": "The ending date for the reporting period, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reporting_owner", + "type": "str | None", + "description": "The name of the reporting owner, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_url", + "type": "str | None", + "description": "The URL to the PDF document, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xls_url", + "type": "str | None", + "description": "The URL to the XLS document, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xbr_url", + "type": "str | None", + "description": "The URL to the XBR document, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "doc_link", + "type": "str | None", + "description": "The URL to the DOC document, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCompanyFilings", + "openapi_extra": { + "model": "NasdaqCompanyFilings" + } + }, + "/nasdaq/equity/calendar/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company earnings releases, with consensus and surprise.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Upcoming and historical earnings releases.\nobb.nasdaq.equity.calendar.earnings(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCalendarEarnings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_previous", + "type": "float | None", + "description": "The earnings-per-share from the same previously reported period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_consensus", + "type": "float | None", + "description": "The analyst conesus earnings-per-share estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "eps_actual", + "type": "float | None", + "description": "The actual earnings per share (USD) announced.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "surprise_percent", + "type": "float | None", + "description": "The earnings surprise as normalized percentage points.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "num_estimates", + "type": "int | None", + "description": "The number of analysts providing estimates for the consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "str | None", + "description": "The fiscal period end date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous_report_date", + "type": "date | None", + "description": "The previous report date for the same period last year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reporting_time", + "type": "str | None", + "description": "The reporting time - e.g. after market close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market cap (USD) of the reporting entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCalendarEarnings", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqCalendarEarnings" + } + }, + "/nasdaq/equity/calendar/dividend": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Ex-dividend, record, and payment dates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Upcoming and historical dividend payments.\nobb.nasdaq.equity.calendar.dividend(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCalendarDividend", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float | None", + "description": "The dividend amount per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "record_date", + "type": "date | None", + "description": "The record date of ownership for eligibility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payment_date", + "type": "date | None", + "description": "The payment date of the dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "declaration_date", + "type": "date | None", + "description": "Declaration date of the dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "annualized_amount", + "type": "float | None", + "description": "The indicated annualized dividend amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCalendarDividend", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqCalendarDividend" + } + }, + "/nasdaq/equity/calendar/ipo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "IPO and secondary offering announcements, pricings, and withdrawals.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# IPO announcements and pricings.\nobb.nasdaq.equity.calendar.ipo(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "status", + "type": "str | None", + "description": "The status of the offering.", + "default": "priced", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_spo", + "type": "bool | None", + "description": "If True, returns secondary public offerings (SPOs) instead.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCalendarIpo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ipo_date", + "type": "date | None", + "description": "The date of the IPO, when the stock first trades on a major exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "offer_amount", + "type": "float | None", + "description": "The dollar value of the shares offered.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "share_count", + "type": "int | None", + "description": "The number of shares offered.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expected_price_date", + "type": "date | None", + "description": "The date the pricing is expected.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filed_date", + "type": "date | None", + "description": "The date the offering was filed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "withdraw_date", + "type": "date | None", + "description": "The date the offering was withdrawn.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deal_status", + "type": "str | None", + "description": "The status of the deal.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCalendarIpo", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqCalendarIpo" + } + }, + "/nasdaq/equity/calendar/splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Announced stock splits and their effective dates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Upcoming stock splits.\nobb.nasdaq.equity.calendar.splits(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCalendarSplits", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock split.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock split.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ratio_display", + "type": "str | None", + "description": "The split ratio, as published - i.e., '16 : 1'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payable_date", + "type": "date | None", + "description": "The effective date of the split.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCalendarSplits", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqCalendarSplits" + } + }, + "/nasdaq/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Income statement, as published on the Nasdaq financials tab.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The annual income statement.\nobb.nasdaq.equity.fundamental.income(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "period", + "type": "str | None", + "description": "The reporting period. Nasdaq publishes the last four periods of each statement.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqIncomeStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue", + "type": "float | None", + "description": "Total Revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cost_of_revenue", + "type": "float | None", + "description": "Cost of Revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_profit", + "type": "float | None", + "description": "Gross Profit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_operating_expenses", + "type": "float | None", + "description": "Operating Expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "research_and_development_expense", + "type": "float | None", + "description": "Research and Development.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "selling_general_and_administrative_expense", + "type": "float | None", + "description": "Sales, General and Admin.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_recurring_items", + "type": "float | None", + "description": "Non-Recurring Items.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_operating_expenses", + "type": "float | None", + "description": "Other Operating Items.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_income", + "type": "float | None", + "description": "Operating Income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "additional_income_expense_items", + "type": "float | None", + "description": "Add'l income/expense items.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ebit", + "type": "float | None", + "description": "Earnings Before Interest and Tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense", + "type": "float | None", + "description": "Interest Expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_before_tax", + "type": "float | None", + "description": "Earnings Before Tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_tax_expense", + "type": "float | None", + "description": "Income Tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minority_interest", + "type": "float | None", + "description": "Minority Interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_earnings", + "type": "float | None", + "description": "Equity Earnings/Loss Unconsolidated Subsidiary.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_from_continuing_operations", + "type": "float | None", + "description": "Net Income-Cont. Operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consolidated_net_income", + "type": "float | None", + "description": "Net Income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "float | None", + "description": "Net Income Applicable to Common Shareholders.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqIncomeStatement", + "openapi_extra": { + "model": "NasdaqIncomeStatement" + } + }, + "/nasdaq/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Balance sheet, as published on the Nasdaq financials tab.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The annual balance sheet.\nobb.nasdaq.equity.fundamental.balance(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "period", + "type": "str | None", + "description": "The reporting period. Nasdaq publishes the last four periods of each statement.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqBalanceSheet", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_and_cash_equivalents", + "type": "float | None", + "description": "Cash and Cash Equivalents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_investments", + "type": "float | None", + "description": "Short-Term Investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_receivables", + "type": "float | None", + "description": "Net Receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inventory", + "type": "float | None", + "description": "Inventory.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_assets", + "type": "float | None", + "description": "Other Current Assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_current_assets", + "type": "float | None", + "description": "Total Current Assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_investments", + "type": "float | None", + "description": "Long-Term Investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "property_plant_equipment_net", + "type": "float | None", + "description": "Fixed Assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goodwill", + "type": "float | None", + "description": "Goodwill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "intangible_assets", + "type": "float | None", + "description": "Intangible Assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_current_assets", + "type": "float | None", + "description": "Other Assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_asset_charges", + "type": "float | None", + "description": "Deferred Asset Charges.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "float | None", + "description": "Total Assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accounts_payable", + "type": "float | None", + "description": "Accounts Payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_debt", + "type": "float | None", + "description": "Short-Term Debt / Current Portion of Long-Term Debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_liabilities", + "type": "float | None", + "description": "Other Current Liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_current_liabilities", + "type": "float | None", + "description": "Total Current Liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt", + "type": "float | None", + "description": "Long-Term Debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_current_liabilities", + "type": "float | None", + "description": "Other Liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_liability_charges", + "type": "float | None", + "description": "Deferred Liability Charges.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "misc_stocks", + "type": "float | None", + "description": "Misc. Stocks.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minority_interest", + "type": "float | None", + "description": "Minority Interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_liabilities", + "type": "float | None", + "description": "Total Liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stock", + "type": "float | None", + "description": "Common Stocks.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "additional_paid_in_capital", + "type": "float | None", + "description": "Capital Surplus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "retained_earnings", + "type": "float | None", + "description": "Retained Earnings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "treasury_stock", + "type": "float | None", + "description": "Treasury Stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_shareholders_equity", + "type": "float | None", + "description": "Other Equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_shareholders_equity", + "type": "float | None", + "description": "Total Equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_liabilities_and_shareholders_equity", + "type": "float | None", + "description": "Total Liabilities & Equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqBalanceSheet", + "openapi_extra": { + "model": "NasdaqBalanceSheet" + } + }, + "/nasdaq/equity/fundamental/cash": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Cash flow statement, as published on the Nasdaq financials tab.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The annual cash flow statement.\nobb.nasdaq.equity.fundamental.cash(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "period", + "type": "str | None", + "description": "The reporting period. Nasdaq publishes the last four periods of each statement.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCashFlowStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "float | None", + "description": "Net Income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_and_amortization", + "type": "float | None", + "description": "Depreciation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_cash_items", + "type": "float | None", + "description": "Net Income Adjustments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_receivables", + "type": "float | None", + "description": "Accounts Receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_inventory", + "type": "float | None", + "description": "Changes in Inventories.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_operating_activities", + "type": "float | None", + "description": "Other Operating Activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_payables", + "type": "float | None", + "description": "Liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_flow_from_operating_activities", + "type": "float | None", + "description": "Net Cash Flow-Operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_expenditure", + "type": "float | None", + "description": "Capital Expenditures.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_investments", + "type": "float | None", + "description": "Investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_investing_activities", + "type": "float | None", + "description": "Other Investing Activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_flow_from_investing_activities", + "type": "float | None", + "description": "Net Cash Flows-Investing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_stock_issuance", + "type": "float | None", + "description": "Sale and Purchase of Stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_debt_issuance", + "type": "float | None", + "description": "Net Borrowings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_financing_activities", + "type": "float | None", + "description": "Other Financing Activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_flow_from_financing_activities", + "type": "float | None", + "description": "Net Cash Flows-Financing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "effect_of_exchange_rate_changes_on_cash", + "type": "float | None", + "description": "Effect of Exchange Rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_change_in_cash_and_equivalents", + "type": "float | None", + "description": "Net Cash Flow.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCashFlowStatement", + "openapi_extra": { + "model": "NasdaqCashFlowStatement" + } + }, + "/nasdaq/equity/fundamental/ratios": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Liquidity and profitability ratios, as published by Nasdaq.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Liquidity and profitability ratios.\nobb.nasdaq.equity.fundamental.ratios(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "period", + "type": "str | None", + "description": "The reporting period. Nasdaq publishes the last four periods of each statement.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqFinancialRatios", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "date | None", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "Period of the financial ratios.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "Fiscal year.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "current_ratio", + "type": "float | None", + "description": "Current Ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quick_ratio", + "type": "float | None", + "description": "Quick Ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_ratio", + "type": "float | None", + "description": "Cash Ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_profit_margin", + "type": "float | None", + "description": "Gross Margin.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "operating_profit_margin", + "type": "float | None", + "description": "Operating Margin.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "pretax_profit_margin", + "type": "float | None", + "description": "Pre-Tax Margin.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "net_profit_margin", + "type": "float | None", + "description": "Profit Margin.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "pretax_return_on_equity", + "type": "float | None", + "description": "Pre-Tax ROE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_on_equity", + "type": "float | None", + "description": "After Tax ROE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqFinancialRatios", + "openapi_extra": { + "model": "NasdaqFinancialRatios" + } + }, + "/nasdaq/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical dividend payments for a symbol.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The dividend payment history.\nobb.nasdaq.equity.fundamental.dividends(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": false, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqHistoricalDividends", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "dividend_type", + "type": "str | None", + "description": "The type of dividend - i.e., cash, stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency in which the dividend is paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "record_date", + "type": "date | None", + "description": "The record date of ownership for eligibility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payment_date", + "type": "date | None", + "description": "The payment date of the dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "declaration_date", + "type": "date | None", + "description": "Declaration date of the dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqHistoricalDividends", + "openapi_extra": { + "model": "NasdaqHistoricalDividends" + } + }, + "/nasdaq/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported EPS against the consensus forecast, with the surprise.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Reported versus consensus EPS.\nobb.nasdaq.equity.fundamental.historical_eps(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqHistoricalEps", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eps_actual", + "type": "float | int | None", + "description": "Actual EPS from the earnings date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_estimated", + "type": "float | int | None", + "description": "Estimated EPS for the earnings date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "fiscal_period_ending", + "type": "str | None", + "description": "The fiscal quarter the report covers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "surprise_percent", + "type": "float | None", + "description": "The earnings surprise, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqHistoricalEps", + "openapi_extra": { + "model": "NasdaqHistoricalEps" + } + }, + "/nasdaq/equity/ownership/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Insider transactions reported to the SEC.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Recent insider transactions.\nobb.nasdaq.equity.ownership.insider_trading(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of insider transactions to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqInsiderTrading", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_cik", + "type": "str | None", + "description": "CIK number of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | datetime | None", + "description": "Filing date of the trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_date", + "type": "date | None", + "description": "Date of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_cik", + "type": "int | str | None", + "description": "Reporting individual's CIK.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_name", + "type": "str | None", + "description": "Name of the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_title", + "type": "str | None", + "description": "The title held by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ownership_type", + "type": "str | None", + "description": "Type of ownership, e.g., direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type", + "type": "str | None", + "description": "Type of transaction being reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acquisition_or_disposition", + "type": "str | None", + "description": "Acquisition or disposition of the shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The type of security transacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_owned", + "type": "float | None", + "description": "Number of securities owned by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_transacted", + "type": "float | None", + "description": "Number of securities transacted by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_price", + "type": "float | None", + "description": "The price of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_url", + "type": "str | None", + "description": "Link to the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "shares_held", + "type": "float | None", + "description": "Shares held by the insider after the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The Nasdaq profile page for the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqInsiderTrading", + "openapi_extra": { + "model": "NasdaqInsiderTrading" + } + }, + "/nasdaq/equity/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Institutional holders, their positions, and the change since the prior filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The largest institutional holders.\nobb.nasdaq.equity.ownership.institutional(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of institutional holders to return.", + "default": 50, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "holder_type", + "type": "str | None", + "description": "Restrict the holders to those that changed the position in the reported quarter.", + "default": "all", + "optional": true, + "choices": [ + "all", + "increased", + "decreased", + "new", + "sold_out" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort_by", + "type": "str | None", + "description": "The column the holders are ranked by.", + "default": "market_value", + "optional": true, + "choices": [ + "owner_name", + "date", + "shares_held", + "shares_change", + "shares_change_percent", + "market_value" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqInstitutionalOwnership", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "owner_name", + "type": "str | None", + "description": "The name of the institutional holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_held", + "type": "float | None", + "description": "The number of shares held.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_change", + "type": "float | None", + "description": "The change in shares held since the prior filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_change_percent", + "type": "float | None", + "description": "The change in shares held, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "market_value", + "type": "float | None", + "description": "The value of the position, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The Nasdaq portfolio page for the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqInstitutionalOwnership", + "openapi_extra": { + "model": "NasdaqInstitutionalOwnership" + } + }, + "/nasdaq/equity/ownership/short_interest": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Bi-monthly settlement short interest, with days to cover.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The bi-monthly short interest series.\nobb.nasdaq.equity.ownership.short_interest(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEquityShortInterest", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date", + "description": "The mid-month short interest report is based on short positions held by members on the settlement date of the 15th of each month. If the 15th falls on a weekend or another non-settlement date, the designated settlement date will be the previous business day on which transactions settled. The end-of-month short interest report is based on short positions held on the last business day of the month on which transactions settle. Once the short position reports are received, the short interest data is compiled for each equity security and provided for publication on the 7th business day after the reporting settlement date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issue_name", + "type": "str", + "description": "Unique identifier of the issue.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "market_class", + "type": "str", + "description": "Primary listing market.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "current_short_position", + "type": "float", + "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the current cycle\u2019s designated settlement date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "previous_short_position", + "type": "float", + "description": "The total number of shares in the issue that are reflected on the books and records of the reporting firms as short as defined by Rule 200 of Regulation SHO as of the previous cycle\u2019s designated settlement date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "avg_daily_volume", + "type": "float", + "description": "Total Volume or Adjusted Volume in case of splits / Total trade days between (previous settlement date + 1) to (current settlement date). The NULL values are translated as zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "days_to_cover", + "type": "float", + "description": "The number of days of average share volume it would require to buy all of the shares that were sold short during the reporting cycle. Formula: Short Interest / Average Daily Share Volume, Rounded to Hundredths. 1.00 will be displayed for any values equal or less than 1 (i.e., Average Daily Share is equal to or greater than Short Interest). N/A will be displayed If the days to cover is Zero (i.e., Average Daily Share Volume is Zero).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float", + "description": "Change in Shares Short from Previous Cycle: Difference in short interest between the current cycle and the previous cycle.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change_pct", + "type": "float", + "description": "Change in Shares Short from Previous Cycle as a percent.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "issue_name", + "type": "str | None", + "description": "The name of the issue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_class", + "type": "str | None", + "description": "The market classification of the issue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous_short_position", + "type": "float | None", + "description": "The short interest at the prior settlement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change from the prior settlement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_pct", + "type": "float | None", + "description": "The change from the prior settlement, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqEquityShortInterest", + "openapi_extra": { + "model": "NasdaqEquityShortInterest" + } + }, + "/nasdaq/equity/estimates/consensus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Analyst price target consensus, with the buy/hold/sell split.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The analyst price target consensus.\nobb.nasdaq.equity.estimates.consensus(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqPriceTargetConsensus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The company name", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_high", + "type": "float | None", + "description": "High target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_low", + "type": "float | None", + "description": "Low target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_consensus", + "type": "float | None", + "description": "Consensus target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_median", + "type": "float | None", + "description": "Median target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "buy_ratings", + "type": "int | None", + "description": "The number of buy ratings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hold_ratings", + "type": "int | None", + "description": "The number of hold ratings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sell_ratings", + "type": "int | None", + "description": "The number of sell ratings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus_rating", + "type": "str | None", + "description": "The mean analyst rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqPriceTargetConsensus", + "openapi_extra": { + "model": "NasdaqPriceTargetConsensus" + } + }, + "/nasdaq/equity/estimates/price_target": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Recent analyst rating changes. Nasdaq publishes only current actions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Recent upgrades and downgrades.\nobb.nasdaq.equity.estimates.price_target(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqPriceTarget", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "published_date", + "type": "date | datetime", + "description": "Published date of the price target.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "published_time", + "type": "time | None", + "description": "Time of the original rating, UTC.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Exchange where the company is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_name", + "type": "str | None", + "description": "Name of company that is the subject of rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "analyst_name", + "type": "str | None", + "description": "Analyst name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "analyst_firm", + "type": "str | None", + "description": "Name of the analyst firm that published the price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the data is denominated in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_target", + "type": "float | None", + "description": "The current price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adj_price_target", + "type": "float | None", + "description": "Adjusted price target for splits and stock dividends.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_target_previous", + "type": "float | None", + "description": "Previous price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous_adj_price_target", + "type": "float | None", + "description": "Previous adjusted price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_when_posted", + "type": "float | None", + "description": "Price when posted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rating_current", + "type": "str | None", + "description": "The analyst's rating for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rating_previous", + "type": "str | None", + "description": "Previous analyst rating for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "action", + "type": "str | None", + "description": "Description of the change in rating from firm's last rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "model": "NasdaqPriceTarget", + "openapi_extra": { + "model": "NasdaqPriceTarget" + } + }, + "/nasdaq/etf/symbol_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every Nasdaq-traded ETF and mutual fund.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the Nasdaq-traded fund directory.\n >>> obb.nasdaq.etf.symbol_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the Nasdaq-traded fund directory.\nobb.nasdaq.etf.symbol_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/nasdaq/etf/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fund key data - AUM, expense ratio, beta, alpha, and average volumes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The 'Key Data' block for a fund.\nobb.nasdaq.etf.info(symbol='QQQ', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/etf/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEtfInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "Issuer of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "domicile", + "type": "str | None", + "description": "Domicile of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "Website of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inception_date", + "type": "date | None", + "description": "Inception date of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "inception_date", + "type": "date | None", + "description": "The fund's inception date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "aum", + "type": "float | None", + "description": "Assets under management, in thousands.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expense_ratio", + "type": "float | None", + "description": "The fund expense ratio, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market capitalization of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous_close", + "type": "float | None", + "description": "The previous session's closing price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The last session's volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_20d", + "type": "float | None", + "description": "The 20-day average daily volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_50d", + "type": "float | None", + "description": "The 50-day average daily volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_65d", + "type": "float | None", + "description": "The 65-day average daily volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "alpha", + "type": "float | None", + "description": "The fund's alpha.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_alpha", + "type": "float | None", + "description": "The fund's weighted alpha.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "beta", + "type": "float | None", + "description": "The fund's beta.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standard_deviation", + "type": "float | None", + "description": "The fund's standard deviation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_high", + "type": "float | None", + "description": "The 52-week high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The 52-week low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_dividend", + "type": "float | None", + "description": "The most recent distribution amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "management_fee", + "type": "float | None", + "description": "The management fee, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "distribution_fee", + "type": "float | None", + "description": "The account or 12b-1 fee, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "other_expenses", + "type": "float | None", + "description": "Other expenses, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "front_load", + "type": "float | None", + "description": "The front load, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "minimum_initial_investment", + "type": "float | None", + "description": "The minimum initial investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_category", + "type": "str | None", + "description": "The fund investment category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_focus", + "type": "str | None", + "description": "The fund's investment focus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_focus", + "type": "str | None", + "description": "The fund's asset focus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "management_style", + "type": "str | None", + "description": "The fund's management style.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "portfolio_type", + "type": "str | None", + "description": "The fund's portfolio type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_alignment", + "type": "str | None", + "description": "The fund's industry alignment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_of_issuance", + "type": "str | None", + "description": "The fund's country of issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEtfInfo", + "openapi_extra": { + "model": "NasdaqEtfInfo" + } + }, + "/nasdaq/etf/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily OHLCV history for ETFs and mutual funds.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily fund prices.\nobb.nasdaq.etf.historical(symbol='QQQ', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/etf/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEtfHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol, when more than one is requested.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEtfHistorical", + "openapi_extra": { + "model": "NasdaqEtfHistorical" + } + }, + "/nasdaq/etf/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top ten holdings of an ETF or mutual fund, with weights.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The fund's ten largest positions.\nobb.nasdaq.etf.holdings(symbol='QQQ', provider='nasdaq')\n# Mutual funds are served from the fund profile.\nobb.nasdaq.etf.holdings(symbol='PRGFX', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/etf/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEtfHoldings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The symbol of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "The position's weight in the fund, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqEtfHoldings", + "openapi_extra": { + "model": "NasdaqEtfHoldings" + } + }, + "/nasdaq/etf/equity_exposure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the funds carrying an equity as a top-ten holding, with weights.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The funds holding an equity in their top ten.\nobb.nasdaq.etf.equity_exposure(symbol='AAPL', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (underlying equity)", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEtfEquityExposure", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "equity_symbol", + "type": "str", + "description": "The symbol of the equity requested.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "etf_symbol", + "type": "str", + "description": "The symbol of the ETF with exposure to the requested equity.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "The weight of the equity in the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "market_value", + "type": "float | int | None", + "description": "The market value of the equity position in the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares", + "type": "float | int | None", + "description": "Number of reported shares controlled by the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "etf_name", + "type": "str | None", + "description": "The name of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change_100_day", + "type": "float | None", + "description": "The fund's price change over the trailing one hundred days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change_100_day_percent", + "type": "float | None", + "description": "The fund's percent price change over the trailing one hundred days, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqEtfEquityExposure", + "openapi_extra": { + "model": "NasdaqEtfEquityExposure" + } + }, + "/nasdaq/etf/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen ETFs by fund family, sector, asset class, region, and performance.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Screen the ETF universe.\nobb.nasdaq.etf.search(sector='biotech', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "fund_family", + "type": "str | None", + "description": "Filter by the fund family.", + "default": "all_funds", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All funds", + "value": "all_funds" + }, + { + "label": "iShares", + "value": "ishares" + }, + { + "label": "State Street", + "value": "state_street" + }, + { + "label": "Vanguard ETFs", + "value": "vanguard_etfs" + }, + { + "label": "PowerShares", + "value": "powershares" + }, + { + "label": "Wisdom Tree", + "value": "wisdom_tree" + }, + { + "label": "ProShares", + "value": "proshares" + }, + { + "label": "Market Vectors Van Eck Global", + "value": "market_vectors_van_eck_global" + }, + { + "label": "Guggenheim", + "value": "guggenheim" + }, + { + "label": "CurrencyShares", + "value": "currencyshares" + }, + { + "label": "Schwab ETFs", + "value": "schwab_etfs" + }, + { + "label": "First Trust", + "value": "first_trust" + }, + { + "label": "ALPS", + "value": "alps" + }, + { + "label": "iPath ETNs", + "value": "ipath_etns" + }, + { + "label": "Direxion Funds", + "value": "direxion_funds" + }, + { + "label": "FlexShares", + "value": "flexshares" + }, + { + "label": "ETF Securities", + "value": "etf_securities" + }, + { + "label": "United States Commodities Funds", + "value": "united_states_commodities_funds" + }, + { + "label": "Etracs ETNs - UBS", + "value": "etracs_etns_ubs" + }, + { + "label": "Global X Funds", + "value": "global_x_funds" + }, + { + "label": "EG Shares", + "value": "eg_shares" + }, + { + "label": "Elements ETNs", + "value": "elements_etns" + }, + { + "label": "VelocityShares", + "value": "velocityshares" + }, + { + "label": "AdvisorShares", + "value": "advisorshares" + }, + { + "label": "Index IQ", + "value": "index_iq" + }, + { + "label": "Teucrium", + "value": "teucrium" + }, + { + "label": "QuantShares", + "value": "quantshares" + }, + { + "label": "PureFunds", + "value": "purefunds" + }, + { + "label": "VictoryShares", + "value": "victoryshares" + } + ] + } + } + }, + { + "name": "sector", + "type": "str | None", + "description": "Filter by the fund's sector.", + "default": "all_sectors", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Sectors", + "value": "all_sectors" + }, + { + "label": "Agriculture", + "value": "agriculture" + }, + { + "label": "Alternative Investments", + "value": "alternative_investments" + }, + { + "label": "Asia", + "value": "asia" + }, + { + "label": "Biotech", + "value": "biotech" + }, + { + "label": "Bonds", + "value": "bonds" + }, + { + "label": "Commodities", + "value": "commodities" + }, + { + "label": "Construction", + "value": "construction" + }, + { + "label": "Consumer Discretionary", + "value": "consumer_discretionary" + }, + { + "label": "Consumer Non-Cyclical", + "value": "consumer_non_cyclical" + }, + { + "label": "Consumer Services", + "value": "consumer_services" + }, + { + "label": "Consumer Staples", + "value": "consumer_staples" + }, + { + "label": "Currency", + "value": "currency" + }, + { + "label": "Defense", + "value": "defense" + }, + { + "label": "Emerging Markets", + "value": "emerging_markets" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Environmental", + "value": "environmental" + }, + { + "label": "Europe", + "value": "europe" + }, + { + "label": "Financial Services", + "value": "financial_services" + }, + { + "label": "Grains", + "value": "grains" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Hotels & Gambling", + "value": "hotels_and_gambling" + }, + { + "label": "Income", + "value": "income" + }, + { + "label": "Industrial", + "value": "industrial" + }, + { + "label": "International", + "value": "international" + }, + { + "label": "Large Cap", + "value": "large_cap" + }, + { + "label": "Managed ETFs", + "value": "managed_etfs" + }, + { + "label": "Materials", + "value": "materials" + }, + { + "label": "Meats", + "value": "meats" + }, + { + "label": "Metals", + "value": "metals" + }, + { + "label": "Mid Cap", + "value": "mid_cap" + }, + { + "label": "Mixed Asset", + "value": "mixed_asset" + }, + { + "label": "Multi Cap", + "value": "multi_cap" + }, + { + "label": "Natural Resources", + "value": "natural_resources" + }, + { + "label": "Non-Taxable", + "value": "non_taxable" + }, + { + "label": "Power", + "value": "power" + }, + { + "label": "Precious Metals", + "value": "precious_metals" + }, + { + "label": "Real Estate", + "value": "real_estate" + }, + { + "label": "Small Cap", + "value": "small_cap" + }, + { + "label": "Taxable Bonds", + "value": "taxable_bonds" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Telecommunications", + "value": "telecommunications" + }, + { + "label": "Transportation", + "value": "transportation" + }, + { + "label": "Utilities", + "value": "utilities" + } + ] + } + } + }, + { + "name": "asset_class", + "type": "str | None", + "description": "Filter by the fund's asset class.", + "default": "all_asset_classes", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Asset Classes", + "value": "all_asset_classes" + }, + { + "label": "Bond", + "value": "bond" + }, + { + "label": "Commodity", + "value": "commodity" + }, + { + "label": "Currency", + "value": "currency" + }, + { + "label": "Equity", + "value": "equity" + }, + { + "label": "Fixed Income", + "value": "fixed_income" + }, + { + "label": "Liquidated Fund", + "value": "liquidated_fund" + }, + { + "label": "Multi-Asset", + "value": "multi_asset" + }, + { + "label": "Volatility", + "value": "volatility" + } + ] + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "Filter by the fund's geography.", + "default": "all_region", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Region", + "value": "all_region" + }, + { + "label": "Africa", + "value": "africa" + }, + { + "label": "Asia-Pacific", + "value": "asia_pacific" + }, + { + "label": "Europe-Australia and Far East", + "value": "europe_australia_and_far_east" + }, + { + "label": "Europe", + "value": "europe" + }, + { + "label": "Global", + "value": "global" + }, + { + "label": "Latin America", + "value": "latin_america" + }, + { + "label": "Middle East", + "value": "middle_east" + }, + { + "label": "North America", + "value": "north_america" + } + ] + } + } + }, + { + "name": "performance", + "type": "str | None", + "description": "Filter by trailing annual performance.", + "default": "all_performance", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Performance", + "value": "all_performance" + }, + { + "label": "less than -50", + "value": "less_than_neg_50" + }, + { + "label": "between -50 and -25", + "value": "between_neg_50_and_neg_25" + }, + { + "label": "between -25 and -10", + "value": "between_neg_25_and_neg_10" + }, + { + "label": "between -10 and 0", + "value": "between_neg_10_and_0" + }, + { + "label": "between 0 and 5", + "value": "between_0_and_5" + }, + { + "label": "between 5 and 10", + "value": "between_5_and_10" + }, + { + "label": "between 10 and 15", + "value": "between_10_and_15" + }, + { + "label": "between 15 and 20", + "value": "between_15_and_20" + }, + { + "label": "between 20 and 25", + "value": "between_20_and_25" + }, + { + "label": "more than 25", + "value": "more_than_25" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEtfSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The fund symbol.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change from the previous close, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "one_year_percent", + "type": "float | None", + "description": "The trailing one-year return, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqEtfSearch", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/etf/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqEtfSearch" + } + }, + "/nasdaq/index/symbol_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every Nasdaq-calculated index.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the Nasdaq-calculated index directory.\n >>> obb.nasdaq.index.symbol_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the Nasdaq-calculated index directory.\nobb.nasdaq.index.symbol_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/nasdaq/index/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily OHLCV history for Nasdaq-calculated indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily index levels.\nobb.nasdaq.index.historical(symbol='COMP', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/index/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "interval", + "type": "str | None", + "description": "The data interval. One-minute data covers the current session only and ignores the date range.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "1d" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqIndexHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol, when more than one is requested.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqIndexHistorical", + "openapi_extra": { + "model": "NasdaqIndexHistorical" + } + }, + "/nasdaq/index/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen indexes by domicile.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Screen the index universe.\nobb.nasdaq.index.search(index_type='us', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "index_type", + "type": "str | None", + "description": "Filter by the index domicile.", + "default": "all_indexes", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Indexes", + "value": "all_indexes" + }, + { + "label": "International", + "value": "international" + }, + { + "label": "US", + "value": "us" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqIndexSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Name of the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "last_price", + "type": "float | None", + "description": "The last index level.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change from the previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change from the previous close, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqIndexSearch", + "openapi_extra": { + "model": "NasdaqIndexSearch" + } + }, + "/nasdaq/index/snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get current levels, session ranges, and changes for a set of indexes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The headline US indexes.\nobb.nasdaq.index.snapshots(provider='nasdaq')\n# The Nordic headline indexes.\nobb.nasdaq.index.snapshots(region='nordic', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "region", + "type": "str | None", + "description": "The region of focus for the data - i.e., us, eu.", + "default": "us", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "choices": [ + "all", + "us", + "international", + "nordic" + ], + "x-widget_config": { + "options": [ + { + "label": "All", + "value": "all" + }, + { + "label": "US", + "value": "us" + }, + { + "label": "International", + "value": "international" + }, + { + "label": "Nordic", + "value": "nordic" + } + ] + } + } + } + } + ], + "nasdaq": [ + { + "name": "region", + "type": "str | None", + "description": "The index universe to return. Nordic indexes are served from the Nasdaq Nordic listing.", + "default": "us", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqIndexSnapshots", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Current price of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in value of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change, in normalized percentage points, of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The index symbol.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The last session's share volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change, as a normalized percent, of the index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "NasdaqIndexSnapshots", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/index/symbol_choices", + "label": "Symbol", + "value": "", + "show": false + } + ] + }, + "model": "NasdaqIndexSnapshots" + } + }, + "/nasdaq/crypto/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily OHLCV history for the crypto pairs Nasdaq quotes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily crypto prices.\nobb.nasdaq.crypto.historical(symbol='BTC', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqCryptoHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol, when more than one is requested.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqCryptoHistorical", + "openapi_extra": { + "model": "NasdaqCryptoHistorical" + } + }, + "/nasdaq/options/chains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Delayed Nasdaq options chains.\n\nNarrowing with `expiration` populates greeks, implied volatility, and the\nfull quote detail on every contract returned. Without it, Nasdaq only\npublishes greeks for the front expiration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The full chain, with front-expiration greeks.\nobb.nasdaq.options.chains(symbol='AAPL', provider='nasdaq')\n# One expiration, with greeks on every contract.\nobb.nasdaq.options.chains(symbol='NVDA', expiration='2026-08-07', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + } + ], + "nasdaq": [ + { + "name": "exchange", + "type": "str | None", + "description": "The options exchange. 'composite' is the consolidated chain.", + "default": "composite", + "optional": true, + "choices": [ + "composite", + "cbo", + "aoe", + "nyo", + "pho", + "moe", + "box", + "ise", + "bto", + "nso", + "c2o", + "bxo", + "mio", + "mpe", + "edo", + "gem", + "mcry", + "mxop" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str | None | list[str | None]", + "description": "Restrict the chain to one or more comma-separated expiration dates. Every expiration is returned when unset. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqOptionsChains", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "underlying_symbol", + "type": "list[str] | None", + "description": "Underlying symbol for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_price", + "type": "list[float] | None", + "description": "Price of the underlying stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "contract_symbol", + "type": "list[str]", + "description": "Contract symbol for the option.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eod_date", + "type": "list[date] | None", + "description": "Date for which the options chains are returned.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "list[date]", + "description": "Expiration date of the contract.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dte", + "type": "list[int] | None", + "description": "Days to expiration of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strike", + "type": "list[float]", + "description": "Strike price of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "option_type", + "type": "list[str]", + "description": "Call or Put.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "contract_size", + "type": "list[Union[int, float]] | None", + "description": "Number of underlying units per contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "list[Union[int, float]] | None", + "description": "Open interest on the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "list[Union[int, float]] | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "theoretical_price", + "type": "list[float] | None", + "description": "Theoretical value of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_price", + "type": "list[float] | None", + "description": "Last trade price of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_size", + "type": "list[Union[int, float]] | None", + "description": "Last trade size of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "list[datetime] | None", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick", + "type": "list[str] | None", + "description": "Whether the last tick was up or down in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "list[float] | None", + "description": "Current bid price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_size", + "type": "list[Union[int, float]] | None", + "description": "Bid size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_time", + "type": "list[datetime] | None", + "description": "The timestamp of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "list[str] | None", + "description": "The exchange of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "list[float] | None", + "description": "Current ask price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_size", + "type": "list[Union[int, float]] | None", + "description": "Ask size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_time", + "type": "list[datetime] | None", + "description": "The timestamp of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "list[str] | None", + "description": "The exchange of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mark", + "type": "list[float] | None", + "description": "The mid-price between the latest bid and ask.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open", + "type": "list[float] | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_bid", + "type": "list[float] | None", + "description": "The opening bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_ask", + "type": "list[float] | None", + "description": "The opening ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "high", + "type": "list[float] | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_high", + "type": "list[float] | None", + "description": "The highest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_high", + "type": "list[float] | None", + "description": "The highest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "low", + "type": "list[float] | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_low", + "type": "list[float] | None", + "description": "The lowest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_low", + "type": "list[float] | None", + "description": "The lowest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close", + "type": "list[float] | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_size", + "type": "list[Union[int, float]] | None", + "description": "The closing trade size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_time", + "type": "list[datetime] | None", + "description": "The time of the closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid", + "type": "list[float] | None", + "description": "The closing bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_bid_size", + "type": "list[Union[int, float]] | None", + "description": "The closing bid size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid_time", + "type": "list[datetime] | None", + "description": "The time of the bid closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask", + "type": "list[float] | None", + "description": "The closing ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_size", + "type": "list[Union[int, float]] | None", + "description": "The closing ask size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_time", + "type": "list[datetime] | None", + "description": "The time of the ask closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "list[float] | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "list[float] | None", + "description": "The change in the price of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "list[float] | None", + "description": "Change, in normalized percentage points, of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "implied_volatility", + "type": "list[float] | None", + "description": "Implied volatility of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "delta", + "type": "list[float] | None", + "description": "Delta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "gamma", + "type": "list[float] | None", + "description": "Gamma of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "theta", + "type": "list[float] | None", + "description": "Theta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "vega", + "type": "list[float] | None", + "description": "Vega of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "rho", + "type": "list[float] | None", + "description": "Rho of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + } + ], + "nasdaq": [] + }, + "model": "NasdaqOptionsChains", + "openapi_extra": { + "model": "NasdaqOptionsChains" + } + }, + "/nasdaq/economy/calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Macroeconomic events, with consensus, actual, and revised values.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Upcoming and historical macro events.\nobb.nasdaq.economy.calendar(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "Country of the event. Accepts country names, ISO 3166-1 alpha-2/alpha-3 codes. Multiple comma-separated values allowed. Multiple items allowed.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqEconomicCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Category of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "event", + "type": "str | None", + "description": "Event name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "importance", + "type": "str | None", + "description": "The importance level for the event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Source of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus", + "type": "float | str | None", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous", + "type": "float | str | None", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revised", + "type": "float | str | None", + "description": "Revised previous value, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "actual", + "type": "float | str | None", + "description": "Latest released value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "description", + "type": "str | None", + "description": "Event description.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqEconomicCalendar", + "openapi_extra": { + "model": "NasdaqEconomicCalendar" + } + }, + "/nasdaq/markets/movers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Nasdaq market movers - most active, advancers, decliners, and Nasdaq-100.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The most actively traded stocks by share volume.\nobb.nasdaq.markets.movers(provider='nasdaq')\n# The biggest ETF advancers.\nobb.nasdaq.markets.movers(asset_class='etf', category='most_advanced', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "category", + "type": "str | None", + "description": "The mover list to return.", + "default": "most_active_share_volume", + "optional": true, + "choices": [ + "most_active_share_volume", + "most_active_dollar_volume", + "most_advanced", + "most_declined", + "nasdaq_100" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The asset class. Mutual funds publish advancers and decliners only; ETFs add most-active by share volume.", + "default": "stocks", + "optional": true, + "choices": [ + "stocks", + "etf", + "mutualfunds" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "session", + "type": "str | None", + "description": "The trading session the list is ranked over.", + "default": "market", + "optional": true, + "choices": [ + "market", + "pre_market", + "after_hours" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of movers to return.", + "default": 10, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "exchange", + "type": "str | None", + "description": "The exchange to rank.", + "default": "tsx", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Toronto Stock Exchange", + "value": "tsx" + }, + { + "label": "TSX Venture Exchange", + "value": "tsxv" + } + ] + } + } + }, + { + "name": "category", + "type": "str | None", + "description": "The direction to rank by.", + "default": "gainers", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Gainers", + "value": "gainers" + }, + { + "label": "Losers", + "value": "losers" + } + ] + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of movers to return.", + "default": 25, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "MarketMovers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name associated with the ticker.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "The last price of the ticker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float", + "description": "The change in price from open.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in percent from open.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "price", + "type": "float | None", + "description": "The last price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change in price from open.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change in percent from open.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The share or dollar volume, for the most-active lists.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "price", + "type": "float | None", + "description": "The last price of the ticker.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The session open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The session high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The session low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The session share volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_volume", + "type": "int | None", + "description": "The number of trades in the session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "week_52_high", + "type": "float | None", + "description": "The fifty-two week high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "week_52_low", + "type": "float | None", + "description": "The fifty-two week low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the ticker trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "MarketMovers", + "openapi_extra": { + "model": "MarketMovers" + } + }, + "/nasdaq/markets/status": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the US market session status, and the next open and close times.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The current US market session status.\nobb.nasdaq.markets.status(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqMarketStatus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "country", + "type": "str | None", + "description": "The market's country.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "The session status - i.e., 'Open' or 'Closed'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indicator", + "type": "str | None", + "description": "The status message displayed by Nasdaq.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "countdown", + "type": "str | None", + "description": "Time remaining until the next session change.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_business_day", + "type": "bool | None", + "description": "Whether the current day is a trading day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous_trade_date", + "type": "date | None", + "description": "The previous trading day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "next_trade_date", + "type": "date | None", + "description": "The next trading day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pre_market_open", + "type": "datetime | None", + "description": "The pre-market session open, in US/Eastern time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pre_market_close", + "type": "datetime | None", + "description": "The pre-market session close, in US/Eastern time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_open", + "type": "datetime | None", + "description": "The regular session open, in US/Eastern time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_close", + "type": "datetime | None", + "description": "The regular session close, in US/Eastern time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "after_hours_open", + "type": "datetime | None", + "description": "The after-hours session open, in US/Eastern time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "after_hours_close", + "type": "datetime | None", + "description": "The after-hours session close, in US/Eastern time.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqMarketStatus", + "openapi_extra": { + "model": "NasdaqMarketStatus" + } + }, + "/nasdaq/markets/quotes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Batch quotes for any mix of stocks, funds, indexes, and crypto pairs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# A light quote for a mixed-asset watchlist.\nobb.nasdaq.markets.quotes(symbol='AAPL,QQQ,OMXS30', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol, or a comma-separated list. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqPriceQuote", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The Nasdaq asset class of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change from the previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change from the previous close, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The session volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The Nasdaq quote page.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqPriceQuote", + "openapi_extra": { + "model": "NasdaqPriceQuote" + } + }, + "/nasdaq/markets/upcoming": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get counts and a preview of upcoming earnings, dividends, splits, and IPOs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Event counts for the next session.\nobb.nasdaq.markets.upcoming()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Nasdaq Upcoming Events", + "category": "Economy", + "subCategory": "Calendar" + }, + "model": "" + } + }, + "/nasdaq/nordic/symbol_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "``[{label, value}]`` of every instrument Nasdaq Nordic lists.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get the Nasdaq Nordic instrument directory.\n >>> obb.nasdaq.nordic.symbol_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the Nasdaq Nordic instrument directory.\nobb.nasdaq.nordic.symbol_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/nasdaq/nordic/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen shares, funds, indexes, bonds, and derivatives across Nasdaq Nordic.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every share listed on the Nordic main market.\nobb.nasdaq.nordic.screener(provider='nasdaq')\n# First North growth market shares.\nobb.nasdaq.nordic.screener(market='first_north', provider='nasdaq')\n# Swedish corporate bonds.\nobb.nasdaq.nordic.screener(asset_class='corporate_bonds', market='sweden', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "asset_class", + "type": "str | None", + "description": "The Nasdaq Nordic instrument listing to screen.", + "default": "shares", + "optional": true, + "choices": [ + "shares", + "indexes", + "funds", + "etf", + "etn_etc", + "aif", + "amf", + "options", + "custom_basket_forwards", + "corporate_bonds", + "government_bonds", + "mortgage_bonds", + "sustainable_debt", + "fi_derivatives", + "structured_products", + "warrants", + "certificates", + "leverage_certificates", + "tracker_certificates" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "str | None", + "description": "The listing venue. Shares are segmented by market tier and fixed income by country; other asset classes ignore this.", + "default": null, + "optional": true, + "choices": [ + "main_market", + "first_north", + "other_instruments", + "sweden", + "denmark", + "finland", + "iceland" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicScreener", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The instrument symbol.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The instrument name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "The instrument ISIN.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The Nasdaq Nordic asset class.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The sector classification.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "The issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last traded price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change from the previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change from the previous close, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "bid", + "type": "float | None", + "description": "The current bid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "The current ask.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The session high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The session low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The session volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reported_volume", + "type": "float | None", + "description": "The off-book reported volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_volume", + "type": "float | None", + "description": "The total volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "turnover", + "type": "float | None", + "description": "The session turnover, in the trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trades_count", + "type": "float | None", + "description": "The number of trades.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_price", + "type": "float | None", + "description": "The average price across all trades.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_asset_value", + "type": "float | None", + "description": "The fund net asset value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_expense_ratio", + "type": "float | None", + "description": "The fund total expense ratio, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "coupon_rate", + "type": "float | None", + "description": "The bond coupon rate, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "strike", + "type": "float | None", + "description": "The derivative strike price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "contract_size", + "type": "float | None", + "description": "The derivative contract size.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "float | None", + "description": "The derivative open interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basket_value", + "type": "float | None", + "description": "The value of the underlying custom basket.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "theoretical_price", + "type": "float | None", + "description": "The theoretical price of the basket contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferral_threshold", + "type": "float | None", + "description": "The publication deferral threshold.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_price", + "type": "float | None", + "description": "The derivative settlement price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "date | None", + "description": "The instrument expiration date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_traded", + "type": "date | None", + "description": "The date the instrument last traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mic_code", + "type": "str | None", + "description": "The venue MIC code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_notation", + "type": "str | None", + "description": "How the price is quoted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "note_code", + "type": "str | None", + "description": "The exchange note code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "note_description", + "type": "str | None", + "description": "The exchange note description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "instrument_type", + "type": "str | None", + "description": "The instrument type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_symbol", + "type": "str | None", + "description": "The symbol used by the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "green_equity_designation", + "type": "str | None", + "description": "The Nasdaq green equity designation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "orderbook_id", + "type": "str | None", + "description": "The Nasdaq Nordic orderbook identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicScreener", + "openapi_extra": { + "model": "NasdaqNordicScreener" + } + }, + "/nasdaq/nordic/news": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company announcements and exchange notices from the Nasdaq Nordic markets.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The latest exchange notices across every Nordic market.\nobb.nasdaq.nordic.news(provider='nasdaq')\n# Stockholm notices only.\nobb.nasdaq.nordic.news(market='stockholm', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "market", + "type": "str | None", + "description": "The Nasdaq Nordic market to list notices for.", + "default": "all", + "optional": true, + "choices": [ + "all", + "stockholm", + "copenhagen", + "helsinki", + "iceland", + "baltic", + "first_north" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of notices to return.", + "default": 50, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicNews", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "date", + "type": "datetime | str", + "description": "The release time, in CET.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The headline of the notice.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "company", + "type": "str | None", + "description": "The issuing company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "str | None", + "description": "The listing market.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "The disclosure category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "language", + "type": "str | None", + "description": "The language of the notice.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The link to the full notice.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "attachment_url", + "type": "str | None", + "description": "The link to the attached document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "disclosure_id", + "type": "int | None", + "description": "The Nasdaq disclosure identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicNews", + "openapi_extra": { + "model": "NasdaqNordicNews" + } + }, + "/nasdaq/nordic/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the reference and trading metadata for a Nasdaq Nordic instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Bond metadata - coupon, listing day, and repayment terms.\nobb.nasdaq.nordic.info(symbol='CATME_HO1', provider='nasdaq')\n# Share metadata - shares outstanding, ICB code, and segment.\nobb.nasdaq.nordic.info(symbol='ATCO A', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The Nasdaq Nordic instrument symbol.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/nordic/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "category", + "type": "str", + "description": "The section the attribute belongs to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str", + "description": "The attribute name as Nasdaq publishes it.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "str | None", + "description": "The attribute value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "as_of", + "type": "str | None", + "description": "The date the attribute was reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicInfo", + "openapi_extra": { + "model": "NasdaqNordicInfo" + } + }, + "/nasdaq/nordic/fundamentals": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Morningstar fundamentals published for a Nasdaq Nordic listing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Morningstar statements, ratios, and growth rates.\nobb.nasdaq.nordic.fundamentals(symbol='AAK', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The Nasdaq Nordic instrument symbol.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/nordic/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicFundamentals", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "section", + "type": "str | None", + "description": "The fact sheet section the row belongs to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str", + "description": "The line item, as Morningstar publishes it.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The fiscal year, quarter, or horizon the value covers.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The reported value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicFundamentals", + "openapi_extra": { + "model": "NasdaqNordicFundamentals" + } + }, + "/nasdaq/nordic/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the declared distributions for a Nasdaq Nordic listing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Declared distributions, with ex and payment dates.\nobb.nasdaq.nordic.dividends(symbol='AAK', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/nordic/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicDividends", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "payment_date", + "type": "date | None", + "description": "The date the distribution was paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_type", + "type": "str | None", + "description": "The kind of distribution - i.e., 'Cash'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency the amount is declared in.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicDividends", + "openapi_extra": { + "model": "NasdaqNordicDividends" + } + }, + "/nasdaq/nordic/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the daily price history for a Nasdaq Nordic instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily closes, volume, duration, and yield.\nobb.nasdaq.nordic.historical(symbol='CATME_HO1', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The Nasdaq Nordic instrument symbol.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/nordic/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "date", + "type": "date | str", + "description": "The trading day.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The instrument symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The session high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The session low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The closing price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_price", + "type": "float | None", + "description": "The average price across all trades.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The total volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "turnover", + "type": "float | None", + "description": "The turnover, in the trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "duration", + "type": "float | None", + "description": "The bond duration, in years.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "yield_to_maturity", + "type": "float | None", + "description": "The bond yield, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "yield_calculation_price", + "type": "float | None", + "description": "The price the yield was calculated from.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reference_price", + "type": "float | None", + "description": "The consolidated reference price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consolidated_volume", + "type": "float | None", + "description": "The consolidated volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consolidated_turnover", + "type": "float | None", + "description": "The consolidated turnover.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicHistorical", + "openapi_extra": { + "model": "NasdaqNordicHistorical" + } + }, + "/nasdaq/nordic/historical_trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the trade-by-trade history for a Nasdaq Nordic instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every reported trade, with the buying and selling members.\nobb.nasdaq.nordic.historical_trades(symbol='CATME_HO1', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The Nasdaq Nordic instrument symbol.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/nordic/symbol_choices", + "style": { + "popupWidth": 850 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date. Nasdaq publishes three months of trades.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicHistoricalTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "date", + "type": "datetime | str", + "description": "The time of the trade, in CET.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The instrument symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The trade price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trade volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "buyer", + "type": "str | None", + "description": "The buying member.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seller", + "type": "str | None", + "description": "The selling member.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_type", + "type": "str | None", + "description": "The type of trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "str | None", + "description": "The reporting market.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mmt_flag", + "type": "str | None", + "description": "The MiFID market model typology flags.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "orderbook", + "type": "str | None", + "description": "Whether the trade was on or off the orderbook.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cancelled", + "type": "str | None", + "description": "Whether the trade was cancelled.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "agreement_time", + "type": "str | None", + "description": "The time the trade was agreed.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicHistoricalTrades", + "openapi_extra": { + "model": "NasdaqNordicHistoricalTrades" + } + }, + "/nasdaq/nordic/movers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the most traded instruments in a Nasdaq Nordic asset group.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The most traded Nordic shares.\nobb.nasdaq.nordic.movers(provider='nasdaq')\n# The most traded Nordic options and futures.\nobb.nasdaq.nordic.movers(asset_group='options_futures', provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "asset_group", + "type": "str | None", + "description": "The Nasdaq Nordic asset group to rank.", + "default": "shares", + "optional": true, + "choices": [ + "shares", + "options_futures", + "etp", + "funds", + "indexes", + "warrants_certificates" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of movers to return.", + "default": 15, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicMovers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "symbol", + "type": "str | None", + "description": "The instrument symbol.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "The instrument name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "The instrument ISIN.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The Nasdaq Nordic asset class.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The trading currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last traded price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change from the previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change from the previous close, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "bid", + "type": "float | None", + "description": "The current bid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "The current ask.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The session volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_change_percent", + "type": "float | None", + "description": "The change in volume, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "turnover", + "type": "float | None", + "description": "The session turnover.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "turnover_eur", + "type": "float | None", + "description": "The session turnover, in euros.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trades_count", + "type": "float | None", + "description": "The number of trades.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "contract_size", + "type": "float | None", + "description": "The derivative contract size.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "date | None", + "description": "The derivative expiration date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "orderbook_id", + "type": "str | None", + "description": "The Nasdaq Nordic orderbook identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicMovers", + "openapi_extra": { + "model": "NasdaqNordicMovers" + } + }, + "/nasdaq/nordic/derivatives_volume": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the session volume for each Nasdaq Nordic equity derivatives market.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Session volume by derivatives market.\n >>> obb.nasdaq.nordic.derivatives_volume()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Session volume by derivatives market.\nobb.nasdaq.nordic.derivatives_volume()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Nasdaq Nordic Derivatives Volume", + "category": "Derivatives", + "subCategory": "Nordic" + }, + "model": "" + } + }, + "/nasdaq/nordic/knocked_out": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the knocked-out leverage instruments, in buyback or halted.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Leverage instruments whose barrier has been breached.\nobb.nasdaq.nordic.knocked_out(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "state", + "type": "str | None", + "description": "Whether the instrument is in buyback or halted.", + "default": "buyback", + "optional": true, + "choices": [ + "buyback", + "trading_halt" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicKnockedOut", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "isin", + "type": "str | None", + "description": "The instrument ISIN.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The instrument name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "The knock-out status.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The Nasdaq Nordic asset class.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_symbol", + "type": "str | None", + "description": "The venue MIC.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "orderbook_id", + "type": "str | None", + "description": "The Nasdaq Nordic orderbook identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicKnockedOut", + "openapi_extra": { + "model": "NasdaqNordicKnockedOut" + } + }, + "/nasdaq/nordic/bond_yields": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the average bond yield by issuer segment and residual maturity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Average Danish bond yields by maturity bucket.\nobb.nasdaq.nordic.bond_yields(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "basis", + "type": "str | None", + "description": "Whether the yields are reported before or after tax.", + "default": "before_tax", + "optional": true, + "choices": [ + "before_tax", + "after_tax" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicBondYields", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "date", + "type": "date | None | str", + "description": "The reporting date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "segment", + "type": "str", + "description": "The issuer segment.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "attribute", + "type": "str", + "description": "The reported measure.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "maturity", + "type": "str", + "description": "The residual maturity bucket, in years.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The reported value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicBondYields", + "openapi_extra": { + "model": "NasdaqNordicBondYields" + } + }, + "/nasdaq/nordic/index_factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the index factors applied to Danish index-linked mortgage bonds.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Inflation index factors for index-linked bonds.\nobb.nasdaq.nordic.index_factors(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicIndexFactors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "date", + "type": "date | str", + "description": "The date the factor takes effect.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "attribute", + "type": "str", + "description": "The reported factor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The factor value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicIndexFactors", + "openapi_extra": { + "model": "NasdaqNordicIndexFactors" + } + }, + "/nasdaq/nordic/mortgage_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the mortgage rates each Nordic lender lists, by fixed-rate term.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Listed mortgage rates by lender and term.\nobb.nasdaq.nordic.mortgage_rates(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicMortgageRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "lender", + "type": "str", + "description": "The lending institution.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "term", + "type": "str", + "description": "The fixed-rate term.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rate", + "type": "float | None", + "description": "The listed mortgage rate, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "url", + "type": "str | None", + "description": "The lender's mortgage page.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicMortgageRates", + "openapi_extra": { + "model": "NasdaqNordicMortgageRates" + } + }, + "/nasdaq/nordic/trading_hours": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the session hours for each Nasdaq Nordic market and segment.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Session hours for every Nordic market.\nobb.nasdaq.nordic.trading_hours(provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicTradingHours", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "section", + "type": "str", + "description": "The market segment the table covers.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "segment", + "type": "str", + "description": "The traded instrument segment.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "str", + "description": "The Nasdaq Nordic market.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "hours", + "type": "str", + "description": "The session hours, in the market's local time.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicTradingHours", + "openapi_extra": { + "model": "NasdaqNordicTradingHours" + } + }, + "/nasdaq/nordic/holidays": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the dates each Nasdaq Nordic market is closed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The exchange holiday calendar.\nobb.nasdaq.nordic.holidays(year=2026, provider='nasdaq')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "year", + "type": "int | None", + "description": "Restrict the calendar to one year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NasdaqNordicHolidays", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "nasdaq": [ + { + "name": "date", + "type": "date | str", + "description": "The date the market is closed.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "market", + "type": "str", + "description": "The Nasdaq Nordic market.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "instrument_group", + "type": "str", + "description": "The instrument group the closure applies to.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "NasdaqNordicHolidays", + "openapi_extra": { + "model": "NasdaqNordicHolidays" + } + }, + "/news/company": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company News. Get news for one or more companies.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): nasdaq, tmx, yfinance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "nasdaq": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/nasdaq/equity/symbol_choices", + "style": { + "popupWidth": 850 + } + } + }, + "tmx": { + "multiple_items_allowed": true + }, + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "nasdaq": [], + "tmx": [ + { + "name": "page", + "type": "int | None", + "description": "The page number to start from. Use with limit.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CompanyNews", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime | str", + "description": "The date of the data. The date of publication.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Title of the article.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "author", + "type": "str | None", + "description": "Author of the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "excerpt", + "type": "str | None", + "description": "Excerpt of the article text.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "body", + "type": "str | None", + "description": "Body of the article text.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "images", + "type": "Any | None", + "description": "Images associated with the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "URL to the article.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbols", + "type": "str | None", + "description": "Symbols associated with the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "publisher", + "type": "str | None", + "description": "The publisher of the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "topic", + "type": "str | None", + "description": "The Nasdaq topic tag.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "source", + "type": "str | None", + "description": "Source of the news.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "source", + "type": "str | None", + "description": "Source of the news article", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CompanyNews", + "openapi_extra": { + "model": "CompanyNews" + } + }, + "/news/rss": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fetch a registered RSS feed.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.news.rss(source='yahoo_finance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "outlet", + "type": "str", + "description": "Outlet id.", + "default": null, + "optional": true + }, + { + "name": "source", + "type": "str", + "description": "Configured feed key.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Maximum articles to return.", + "default": 20, + "optional": true + }, + { + "name": "fetch_body", + "type": "bool", + "description": "Fetch each article URL for its body.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[NewsItemData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "title", + "type": "str", + "description": "Article headline.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "ISO 8601 publication date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "author", + "type": "str", + "description": "Author (falls back to the feed name).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Canonical article URL from the RSS feed.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "excerpt", + "type": "str", + "description": "Short plain-text summary.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "body", + "type": "str", + "description": "Article body as markdown with inline images.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "RSS News Feed", + "description": "Articles from any RSS/Atom feed registered under [news.rss_feeds] in openbb.toml.", + "type": "newsfeed", + "category": "News", + "subCategory": "RSS", + "source": [ + "RSS" + ], + "gridData": { + "w": 20, + "h": 15 + }, + "refetchInterval": 300000, + "params": [ + { + "paramName": "outlet", + "label": "Provider", + "value": "benzinga", + "description": "News outlet grouping the available feeds.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/news/rss_providers", + "style": { + "popupWidth": 280 + } + }, + { + "paramName": "source", + "label": "Feed", + "value": null, + "description": "Specific feed within the selected provider.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/news/rss_feeds", + "optionsParams": { + "outlet": "$outlet" + }, + "style": { + "popupWidth": 360 + }, + "optional": true + }, + { + "paramName": "limit", + "label": "Limit", + "value": 20, + "description": "Maximum number of articles to return.", + "type": "number", + "optional": true + }, + { + "paramName": "fetch_body", + "label": "Fetch full body", + "value": true, + "description": "Fetch each article URL for its full body.", + "type": "boolean", + "optional": true + } + ] + }, + "model": "" + } + }, + "/news/rss_providers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value}] for active news providers.\n\n Returns\n -------\n list", + "examples": "", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/news/rss_feeds": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value}] for feeds under outlet.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "outlet", + "type": "str", + "description": "Outlet id.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/oecd/list_topic_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value}] for every OECD topic (for dropdowns).\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get OECD topic choices for UI dropdowns.\n >>> obb.oecd.list_topic_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get OECD topic choices for UI dropdowns.\nobb.oecd.list_topic_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/oecd/list_subtopic_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value}] for subtopics within a given topic (for dropdowns).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get subtopic choices for a given topic.\nobb.oecd.list_subtopic_choices(topic='ECO')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "topic", + "type": "str", + "description": "Topic ID to get subtopics for (e.g. 'ECO').", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/oecd/list_dataflows": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List all available OECD dataflows, optionally filtered by topic and subtopic.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List all OECD dataflows.\nobb.oecd.list_dataflows()\n# Filter dataflows by topic.\nobb.oecd.list_dataflows(topic='HEA')\n# List all OECD dataflows.\ndataflows = obb.oecd.utils.list_dataflows()\nprint(dataflows.results)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "topic", + "type": "str", + "description": "Filter dataflows by topic ID (e.g. 'ECO', 'HEA', 'ENV'). Use list_topics() to see all available topics.", + "default": null, + "optional": true + }, + { + "name": "subtopic", + "type": "str", + "description": "Filter dataflows by subtopic ID within the selected topic.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "OECD Dataflows", + "description": "All available OECD dataflows, optionally filtered by topic.", + "params": [ + { + "paramName": "topic", + "label": "Topic", + "value": null, + "description": "Filter by topic. Leave blank to show all.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_topic_choices", + "style": { + "popupWidth": 500 + }, + "optional": true + }, + { + "paramName": "subtopic", + "label": "Subtopic", + "value": null, + "description": "Filter by subtopic (requires a topic to be selected).", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_subtopic_choices", + "optionsParams": { + "topic": "$topic" + }, + "style": { + "popupWidth": 500 + }, + "optional": true + } + ], + "gridData": { + "w": 20, + "h": 15 + }, + "refetchInterval": false, + "source": [ + "OECD" + ], + "category": "OECD Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/oecd/list_dataflow_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value}] for every OECD dataflow (for dropdowns).\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # Get OECD dataflow choices for UI dropdowns.\n >>> obb.oecd.list_dataflow_choices()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get OECD dataflow choices for UI dropdowns.\nobb.oecd.list_dataflow_choices()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/oecd/list_topics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List all OECD topic categories with dataflow counts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List all OECD topics.\nobb.oecd.list_topics()\n# Search topics.\nobb.oecd.list_topics(query='health')\n# Browse OECD topics and subtopics.\ntopics = obb.oecd.utils.list_topics()\nprint(topics.results)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Filter rows by topic or subtopic name.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "OECD Topics", + "description": "All OECD topic categories with dataflow counts.", + "params": [ + { + "paramName": "query", + "label": "Search", + "value": null, + "description": "Filter by topic or subtopic name.", + "optional": true + } + ], + "gridData": { + "w": 30, + "h": 20 + }, + "refetchInterval": false, + "source": [ + "OECD" + ], + "category": "OECD Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/oecd/get_dataflow_parameters": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Dataflow parameters and possible dimension values.\n\nReturns an OBBject with either a JSON dict or markdown string under results.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get parameters for the 'DF_PRICES_ALL' dataflow in markdown.\nobb.oecd.get_dataflow_parameters(dataflow_id='DF_PRICES_ALL', output_format='markdown')\n# Get parameters for the 'DF_CLI' dataflow as JSON.\nobb.oecd.get_dataflow_parameters(dataflow_id='DF_CLI', output_format='json')\n# Inspect dimensions of the 'DF_QNA' dataflow.\nparams = obb.oecd.utils.get_dataflow_parameters('DF_QNA')\nprint(params.results)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "dataflow_id", + "type": "str", + "description": "The OECD dataflow ID. Use list_dataflows() to see available dataflows.", + "default": null, + "optional": false + }, + { + "name": "output_format", + "type": "str", + "description": "", + "default": "json", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "OECD Dataflow Parameters", + "type": "markdown", + "params": [ + { + "paramName": "dataflow_id", + "label": "Dataflow", + "value": "DF_PRICES_ALL", + "description": "The OECD dataflow to inspect.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_dataflow_choices", + "style": { + "popupWidth": 700 + } + }, + { + "paramName": "output_format", + "value": "markdown", + "show": false + } + ], + "data": { + "dataKey": "results" + }, + "source": [ + "OECD" + ], + "category": "OECD Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/oecd/list_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List all OECD tables with keyword search, topic, subtopic, and dataflow ID filtering.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List all OECD tables.\nobb.oecd.list_tables()\n# Search for GDP tables.\nobb.oecd.list_tables(query='GDP')\n# Filter by topic.\nobb.oecd.list_tables(topic='HEA')\n# Find a specific table by dataflow ID.\nobb.oecd.list_tables(dataflow_id='DF_PRICES_ALL')\n# Search OECD tables.\ntables = obb.oecd.utils.list_tables(query='prices')\nprint(tables.results)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Keyword search. Space-separated terms are AND-ed; use | for OR within a word.", + "default": null, + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Filter by topic ID (e.g. 'ECO', 'HEA'). Use list_topics() to see all topics.", + "default": null, + "optional": true + }, + { + "name": "subtopic", + "type": "str", + "description": "Filter by subtopic ID within the selected topic.", + "default": null, + "optional": true + }, + { + "name": "dataflow_id", + "type": "str", + "description": "Filter by exact or partial dataflow (table) ID (e.g. 'DF_PRICES_ALL').", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "OECD Tables", + "description": "Searchable map of all OECD tables, optionally filtered by topic.", + "params": [ + { + "paramName": "topic", + "label": "Topic", + "value": null, + "description": "Filter by topic. Leave blank to show all.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_topic_choices", + "style": { + "popupWidth": 700 + }, + "optional": true + }, + { + "paramName": "subtopic", + "label": "Subtopic", + "value": null, + "description": "Filter by subtopic (requires a topic to be selected).", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_subtopic_choices", + "optionsParams": { + "topic": "$topic" + }, + "style": { + "popupWidth": 500 + }, + "optional": true + }, + { + "paramName": "query", + "label": "Search", + "value": null, + "description": "Keyword search across name, topic, and dataflow ID.", + "optional": true + }, + { + "paramName": "dataflow_id", + "label": "Dataflow ID", + "value": null, + "description": "Filter by exact or partial dataflow ID (e.g. 'DF_PRICES_ALL').", + "optional": true + } + ], + "gridData": { + "w": 40, + "h": 20 + }, + "refetchInterval": false, + "source": [ + "OECD" + ], + "category": "OECD Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/oecd/get_table_detail": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Full dimension and indicator breakdown for a single OECD table.\n\nReturns a markdown document with:\n- Table name and description\n- Each dimension as a collapsible section with allowed values\n- Table groups (TABLE_IDENTIFIER), if present\n- Indicator count and hierarchy summary", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get full detail for the DF_PRICES_ALL table.\nobb.oecd.get_table_detail(table_id='DF_PRICES_ALL')\n# Inspect a national accounts table.\nobb.oecd.get_table_detail(table_id='DF_T725R_Q')\n# Describe a table.\ndetail = obb.oecd.utils.get_table_detail(table_id='DF_QNA')\nprint(detail.results)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "table_id", + "type": "str", + "description": "The OECD dataflow (table) ID. Use list_tables() to find IDs.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "OECD Table Detail", + "description": "Full dimension breakdown for a single OECD table, including indicator hierarchy.", + "type": "markdown", + "params": [ + { + "paramName": "table_id", + "label": "Table", + "value": "DF_PRICES_ALL", + "description": "The OECD table (dataflow) to inspect.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_table_choices", + "style": { + "popupWidth": 950 + } + } + ], + "data": { + "dataKey": "results" + }, + "gridData": { + "w": 40, + "h": 25 + }, + "refetchInterval": false, + "source": [ + "OECD" + ], + "category": "OECD Utilities", + "subCategory": "Metadata" + }, + "model": "" + } + }, + "/oecd/list_table_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return [{label, value}] for OECD tables (for dropdowns), optionally filtered by topic.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get table choices for dropdowns.\nobb.oecd.list_table_choices()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "topic", + "type": "str", + "description": "Filter choices by topic ID (e.g. 'ECO'). Leave blank for all.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/oecd/presentation_table_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get presentation table choices for OECD data retrieval.\n\n Progressive cascading selector using the OECD metadata taxonomy.\n All data is discovered dynamically from the OECD SDMX metadata \u2014\n topics, subtopics, dataflows, and their TABLE_IDENTIFIER dimension\n values are resolved at runtime.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the topic choices (step 0).\nobb.oecd.presentation_table_choices()\n# Get subtopic choices for the 'ECO' topic (step 1).\nobb.oecd.presentation_table_choices(topic='ECO')\n# Get table choices for topic and subtopic (step 2).\nobb.oecd.presentation_table_choices(topic='ECO', subtopic='ECO.EO')\n# Get country choices for a specific table (step 3).\nobb.oecd.presentation_table_choices(topic='ECO', subtopic='ECO.EO', table='DF_QNA::T0101')\n# Get frequency choices (step 4).\nobb.oecd.presentation_table_choices(topic='ECO', subtopic='ECO.EO', table='DF_QNA::T0101', country='USA')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "topic", + "type": "str", + "description": "OECD topic code (e.g. 'ECO'). Omit to list all topics.", + "default": null, + "optional": true + }, + { + "name": "subtopic", + "type": "str", + "description": "OECD subtopic code (e.g. 'ECO.EO'). Enter a topic to see choices. Pure UI convenience \u2014 not required for API / Python usage.", + "default": null, + "optional": true + }, + { + "name": "table", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country code. Enter a topic and table to see choices.", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "Frequency code. Enter topic, table, and country to see choices.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/oecd/presentation_table": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a formatted presentation table from the OECD database.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get quarterly GDP output table for the United States.\nobb.oecd.presentation_table(topic='ECO', table='DF_QNA::T0101', country='USA', frequency='Q', limit=4)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "topic", + "type": "str", + "description": "The OECD topic code. UI navigation aid \u2014 not required when table is provided directly.", + "default": null, + "optional": true + }, + { + "name": "subtopic", + "type": "str", + "description": "The OECD subtopic code (e.g. 'ECO.EO'). UI navigation aid \u2014 not required when table is provided directly.", + "default": null, + "optional": true + }, + { + "name": "table", + "type": "str", + "description": "The OECD presentation table key. Accepts 'DATAFLOW::TABLE_ID' or bare 'DATAFLOW_ID'. See presentation_table_choices() for options.", + "default": null, + "optional": true + }, + { + "name": "country", + "type": "str", + "description": "Country code to filter the data. Enter multiple codes by joining on '+'. See presentation_table_choices() for options.", + "default": null, + "optional": true + }, + { + "name": "counterpart", + "type": "str", + "description": "Counterpart area code for bilateral data (e.g. 'W' for World, 'USA'). When omitted, auto-selected (defaults to World aggregate).", + "default": null, + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "The data frequency. See presentation_table_choices() for options. Typical values are 'A' (annual), 'Q' (quarter), 'M' (month).", + "default": null, + "optional": true + }, + { + "name": "unit_measure", + "type": "str", + "description": "Unit of measure code. E.g. 'XDC' (national currency), 'USD_EXC' (US dollars), 'PS' (persons), 'PT_B1GQ' (% of GDP). When omitted, auto-selected via availability.", + "default": null, + "optional": true + }, + { + "name": "adjustment", + "type": "str", + "description": "Seasonal adjustment code. 'Y' = seasonally adjusted, 'N' = not adjusted. When omitted, prefers 'Y' where available, falls back to 'N'.", + "default": null, + "optional": true + }, + { + "name": "transformation", + "type": "str", + "description": "Data transformation code. E.g. 'N' (none), 'GY' (growth year-on-year), 'IX' (index). When omitted, auto-selected via availability.", + "default": null, + "optional": true + }, + { + "name": "dimension_values", + "type": "list[str] | str", + "description": "Dimension selection for filtering. Format: 'DIM_ID1:VAL1+VAL2.'", + "default": null, + "optional": true + }, + { + "name": "start_date", + "type": "str", + "description": "Earliest date to include (ISO format, e.g. '2020-01-01'). Filters out obsolete rows that stopped reporting before this date.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "str", + "description": "Latest date to include (ISO format, e.g. '2025-12-31').", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Maximum number of records to retrieve per series.", + "default": 1, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "topic", + "label": "Topic", + "value": null, + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/presentation_table_choices", + "description": "The OECD topic." + }, + { + "paramName": "subtopic", + "label": "Subtopic", + "value": null, + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/presentation_table_choices", + "optionsParams": { + "topic": "$topic" + }, + "style": { + "popupWidth": 500 + }, + "description": "Filter by subtopic. UI convenience only.", + "show": true + }, + { + "paramName": "table", + "label": "Table", + "type": "endpoint", + "value": null, + "optionsEndpoint": "/api/v1/oecd/presentation_table_choices", + "optionsParams": { + "topic": "$topic", + "subtopic": "$subtopic" + }, + "style": { + "popupWidth": 950 + }, + "description": "The OECD presentation table (DATAFLOW::TABLE_ID)." + }, + { + "paramName": "country", + "label": "Country", + "description": "Country or region for the table.", + "type": "endpoint", + "multiSelect": true, + "optionsEndpoint": "/api/v1/oecd/presentation_table_choices", + "optionsParams": { + "topic": "$topic", + "subtopic": "$subtopic", + "table": "$table" + } + }, + { + "paramName": "counterpart", + "label": "Counterpart", + "type": "endpoint", + "multiSelect": true, + "optionsEndpoint": "/api/v1/oecd/presentation_table_dim_choices", + "optionsParams": { + "table": "$table", + "country": "$country", + "frequency": "$frequency", + "dimension": "counterpart_area" + }, + "style": { + "popupWidth": 400 + }, + "description": "Counterpart area for bilateral data. Leave blank for auto-selection (World).", + "optional": true + }, + { + "paramName": "frequency", + "label": "Frequency", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/presentation_table_choices", + "optionsParams": { + "topic": "$topic", + "subtopic": "$subtopic", + "table": "$table", + "country": "$country" + }, + "description": "The data frequency." + }, + { + "paramName": "unit_measure", + "label": "Unit Measure", + "type": "endpoint", + "value": null, + "optionsEndpoint": "/api/v1/oecd/presentation_table_dim_choices", + "optionsParams": { + "table": "$table", + "country": "$country", + "frequency": "$frequency", + "dimension": "unit_measure" + }, + "style": { + "popupWidth": 400 + }, + "description": "Unit of measure. Leave blank for auto-selection." + }, + { + "paramName": "adjustment", + "label": "Adjustment", + "type": "endpoint", + "value": null, + "optionsEndpoint": "/api/v1/oecd/presentation_table_dim_choices", + "optionsParams": { + "table": "$table", + "country": "$country", + "frequency": "$frequency", + "dimension": "adjustment" + }, + "description": "Seasonal adjustment type. Leave blank for auto-selection.", + "optional": true + }, + { + "paramName": "transformation", + "label": "Transformation", + "type": "endpoint", + "value": null, + "optionsEndpoint": "/api/v1/oecd/presentation_table_dim_choices", + "optionsParams": { + "table": "$table", + "country": "$country", + "frequency": "$frequency", + "dimension": "transformation" + }, + "description": "Data transformation. Leave blank for auto-selection.", + "optional": true + }, + { + "paramName": "dimension_values", + "label": "Dimension Values", + "type": "text", + "value": null, + "description": "Dimension selection for filtering. Format: 'DIM_ID1:VAL1+VAL2.' See the Metadata tab for available dimensions and values.", + "multiple": true, + "multiSelect": false + }, + { + "paramName": "start_date", + "label": "Start Date", + "type": "date", + "value": null, + "description": "Earliest date to include (ISO format). Filters out obsolete data.", + "optional": true + }, + { + "paramName": "end_date", + "label": "End Date", + "type": "date", + "value": null, + "description": "Latest date to include (ISO format).", + "optional": true + }, + { + "paramName": "limit", + "label": "Limit", + "value": 5, + "description": "Most recent N records to retrieve per series.", + "type": "number" + } + ], + "runButton": true, + "refetchInterval": false, + "name": "OECD Presentation Table", + "description": "Presentation tables from the OECD database.", + "source": [ + "OECD" + ], + "category": "OECD Utilities", + "subCategory": "Presentation Tables" + }, + "model": "" + } + }, + "/oecd/available_indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the OECD SDMX catalogue for indicators across all dataflows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.available_indicators(provider='oecd')\n# Filter by topic.\nobb.oecd.available_indicators(provider='oecd', topic='ECO')\n```\n\n", + "parameters": { + "standard": [], + "oecd": [ + { + "name": "topic", + "type": "str | None", + "description": "Filter to a topic ID (e.g. 'ECO', 'HEA'). Use list_topics() to see available topics.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Topic", + "description": "Filter by topic. Leave blank for all topics.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/list_topic_choices", + "style": { + "popupWidth": 600 + }, + "optional": true + } + } + }, + { + "name": "dataflows", + "type": "list[str] | str | None", + "description": "Filter by dataflow ID(s). Comma-separated or list. e.g. 'DF_KEI' or 'DF_KEI,DF_QNA'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "query", + "type": "str | None", + "description": "Search string. Use quotes for exact phrases, + for AND, | for OR. e.g. 'GDP growth', 'CPI | inflation', 'balance +trade'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "keywords", + "type": "list[str] | str | None", + "description": "Single-word keyword filter(s). Prefix with 'not' to exclude.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AvailableOecdIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol_root", + "type": "str | None", + "description": "The root symbol representing the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The name of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "iso", + "type": "str | None", + "description": "The ISO code of the country, region, or entity represented by the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The description of the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the indicator data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "label", + "type": "str | None", + "description": "Short human-readable name of the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dataflow_id", + "type": "str", + "description": "Dataflow identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dataflow_name", + "type": "str | None", + "description": "Human-readable dataflow name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dimension_id", + "type": "str | None", + "description": "Dimension containing the indicator.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent", + "type": "str | None", + "description": "Parent indicator code in the codelist hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frequencies", + "type": "list[str] | None", + "description": "Available observation frequencies (e.g. Annual, Quarterly, Monthly).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transformations", + "type": "list[str] | None", + "description": "Available data transformations (e.g. Growth rate, Index).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "member_of", + "type": "list[str] | None", + "description": "Other OECD dataflows that also contain this indicator code.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "AvailableOecdIndicators", + "openapi_extra": { + "model": "AvailableOecdIndicators" + } + }, + "/oecd/indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get economic indicators by country and indicator symbol from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fetch a single indicator series by ``dataflow::code`` symbol.\nobb.oecd.indicators(provider='oecd', symbol='DF_KEI::ULC', country='united_states', start_date='2020-01-01')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): oecd.", + "default": null, + "optional": false, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "x-widget_config": { + "multiSelect": false, + "multiple": false, + "type": "text" + } + } + } + }, + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): oecd.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "x-widget_config": { + "type": "endpoint", + "multiSelect": false, + "optionsEndpoint": "/api/v1/oecd/indicator_choices", + "optionsParams": { + "symbol": "$symbol", + "country": "true", + "dimension_values": "$dimension_values" + }, + "style": { + "popupWidth": 500 + } + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/indicator_choices", + "optionsParams": { + "symbol": "$symbol", + "country": "$country", + "frequency": "true", + "dimension_values": "$dimension_values" + } + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "symbol", + "type": "str", + "description": "OECD indicator symbol(s). Format: 'DATAFLOW::INDICATOR' or 'DATAFLOW::TABLE_ID'. Multiple symbols from the same dataflow can be comma-separated.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country name or ISO code. Comma-separated for multiples. 'all' for all.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency: 'annual'/'yearly', 'quarterly'/'quarter', 'monthly'/'month', or SDMX code (A/Q/M).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation code (dataflow-specific, e.g. 'GY' for growth rate).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/oecd/indicator_choices", + "optionsParams": { + "symbol": "$symbol", + "country": "$country", + "frequency": "$frequency", + "transform": "true", + "dimension_values": "$dimension_values" + }, + "style": { + "popupWidth": 500 + } + } + } + }, + { + "name": "dimension_values", + "type": "list[str] | str | None | list[list[str] | str | None]", + "description": "Additional dimension constraints. Format: 'DIM_ID:VALUE'. e.g. ['SECTOR:S1', 'UNIT_MEASURE:USD_PPP'] Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "value": null, + "multiple": true, + "multiSelect": false + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of most recent observations per series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Limit", + "type": "number" + } + } + }, + { + "name": "pivot", + "type": "bool | None", + "description": "If True, pivot dates to columns for presentation-table output.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdIndicators", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol_root", + "type": "str | None", + "description": "The root symbol for the indicator (e.g. GDP).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country represented by the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "unit", + "type": "str | None", + "description": "Unit of measurement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit_multiplier", + "type": "float | int | None", + "description": "Unit multiplier (power of 10).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "scale", + "type": "str | None", + "description": "Scale description (e.g. Thousands, Millions).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "float | int | None", + "description": "Sort order within the table hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level", + "type": "int | None", + "description": "Indentation level in the table hierarchy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Human-readable title of the series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Indicator description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str | None", + "description": "ISO country code.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "OecdIndicators", + "openapi_extra": { + "model": "OecdIndicators" + } + }, + "/oecd/balance_of_payments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Balance of Payments reports from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.balance_of_payments(provider='oecd')\nobb.oecd.balance_of_payments(provider='oecd', country='brazil')\n```\n\n", + "parameters": { + "standard": [], + "oecd": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "czechia", + "denmark", + "estonia", + "euro_area_20_countries", + "eu27", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency of the data.", + "default": "quarterly", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdBalanceOfPayments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "date | None", + "description": "The date representing the beginning of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_percent_of_gdp", + "type": "float | None", + "description": "Current Account Balance as Percent of GDP", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "balance_total", + "type": "float | None", + "description": "Current Account Total Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_services", + "type": "float | None", + "description": "Current Account Total Services Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_secondary_income", + "type": "float | None", + "description": "Current Account Total Secondary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_goods", + "type": "float | None", + "description": "Current Account Total Goods Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_total_primary_income", + "type": "float | None", + "description": "Current Account Total Primary Income Balance (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Credits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "credits_total_services", + "type": "float | None", + "description": "Current Account Credits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_goods", + "type": "float | None", + "description": "Current Account Credits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_primary_income", + "type": "float | None", + "description": "Current Account Credits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total_secondary_income", + "type": "float | None", + "description": "Current Account Credits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credits_total", + "type": "float | None", + "description": "Current Account Credits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_services_percent_of_goods_and_services", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Goods and Services", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_services_percent_of_current_account", + "type": "float | None", + "description": "Current Account Debits Services as Percent of Current Account", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "debits_total_services", + "type": "float | None", + "description": "Current Account Debits Total Services (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_goods", + "type": "float | None", + "description": "Current Account Debits Total Goods (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_primary_income", + "type": "float | None", + "description": "Current Account Debits Total Primary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total", + "type": "float | None", + "description": "Current Account Debits Total (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debits_total_secondary_income", + "type": "float | None", + "description": "Current Account Debits Total Secondary Income (USD)", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdBalanceOfPayments", + "openapi_extra": { + "model": "OecdBalanceOfPayments" + } + }, + "/oecd/composite_leading_indicator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the OECD Composite Leading Indicator (CLI).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.composite_leading_indicator(provider='oecd')\nobb.oecd.composite_leading_indicator(country='all', provider='oecd', growth_rate=True)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "Country to get the CLI for, default is G20. Multiple items allowed.", + "default": "g20", + "optional": true, + "choices": [ + "asia5", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu27", + "euro_area_19_countries", + "euro_area_20_countries", + "europe4", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "nafta", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_europe", + "oecd_non_euro_area", + "poland", + "portugal", + "romania", + "russia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude.", + "default": "amplitude", + "optional": true, + "choices": [ + "amplitude", + "normalized" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "amplitude", + "normalized" + ] + } + }, + { + "name": "growth_rate", + "type": "bool | None", + "description": "Return the 1-year growth rate (%) of the CLI, default is False.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdCompositeLeadingIndicator", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "CLI value", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "index" + } + }, + { + "name": "country", + "type": "str", + "description": "Country for the CLI value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdCompositeLeadingIndicator", + "openapi_extra": { + "model": "OecdCompositeLeadingIndicator" + } + }, + "/oecd/cpi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Consumer Price Index (CPI) data by country from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.cpi(country='united_states,united_kingdom', transform='period', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): oecd.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu27", + "euro_area_20_countries", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_europe", + "poland", + "portugal", + "romania", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu27", + "euro_area_20_countries", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_europe", + "poland", + "portugal", + "romania", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ] + } + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation of the CPI data.", + "default": "yoy", + "optional": true, + "choices": [ + "index", + "yoy", + "period" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "choices": [ + "index", + "yoy", + "period" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [ + "annual", + "quarter", + "monthly" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "choices": [ + "annual", + "quarter", + "monthly" + ] + } + } + }, + { + "name": "harmonized", + "type": "bool | None", + "description": "If true, returns harmonized data.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "expenditure", + "type": "str | None | list[str | None]", + "description": "Expenditure component of CPI. Multiple items allowed.", + "default": "total", + "optional": true, + "choices": [ + "actual_rentals", + "alcoholic_beverages_tobacco_narcotics", + "all_non_food_non_energy", + "clothing_footwear", + "communication", + "education", + "electricity_gas_other_fuels", + "energy", + "food_non_alcoholic_beverages", + "fuels_lubricants_personal", + "furniture_household_equipment", + "goods", + "health", + "housing", + "housing_excluding_rentals", + "housing_water_electricity_gas", + "imputed_rentals", + "maintenance_repair_dwelling", + "miscellaneous_goods_services", + "overall_excl_energy_food_alcohol_tobacco", + "recreation_culture", + "residuals", + "restaurants_hotels", + "services", + "services_less_house_excl_rentals", + "services_less_housing", + "total", + "transport", + "water_supply_other_services", + "all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdConsumerPriceIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "None", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "CPI index value or period change.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "unit", + "type": "str", + "description": "Unit of measurement.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit_multiplier", + "type": "float | int", + "description": "Unit multiplier for the observation value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country_code", + "type": "str", + "description": "ISO3 country code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "series_id", + "type": "str", + "description": "OECD series identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "expenditure", + "type": "str", + "description": "Expenditure component of CPI.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Complete reference title for the series.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "int | None", + "description": "Sort order for expenditure categories.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "OecdConsumerPriceIndex", + "openapi_extra": { + "model": "OecdConsumerPriceIndex" + } + }, + "/oecd/country_interest_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get interest rates by country and duration from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.country_interest_rates(provider='oecd')\nobb.oecd.country_interest_rates(provider='oecd', country='all', duration='immediate', frequency='quarter')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): oecd.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu27", + "euro_area", + "euro_area_19_countries", + "euro_area_20_countries", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_europe", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu27", + "euro_area", + "euro_area_19_countries", + "euro_area_20_countries", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_europe", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ] + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "duration", + "type": "str | None", + "description": "Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate.", + "default": "short", + "optional": true, + "choices": [ + "immediate", + "short", + "long" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency to get interest rate for for.", + "default": "monthly", + "optional": true, + "choices": [ + "monthly", + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdCountryInterestRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The interest rate value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurment": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "country", + "type": "str | None", + "description": "Country for which the interest rate is given.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdCountryInterestRates", + "openapi_extra": { + "model": "OecdCountryInterestRates" + } + }, + "/oecd/gdp_nominal": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Nominal GDP data from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.gdp_nominal(provider='oecd')\nobb.oecd.gdp_nominal(units='capita', country='all', frequency='annual', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Use 'all' to get data for all available countries. Multiple items allowed.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu15", + "eu27", + "euro_area_20_countries", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_26_countries", + "oecd_europe", + "poland", + "portugal", + "romania", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "usmca", + "all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency of the data.", + "default": "quarter", + "optional": true, + "choices": [ + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "quarter", + "annual" + ] + } + }, + { + "name": "units", + "type": "str | None", + "description": "The unit of measurement for the data.Both 'level' and 'capita' (per) are measured in USD.", + "default": "level", + "optional": true, + "choices": [ + "level", + "index", + "capita" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "level", + "index", + "capita" + ] + } + }, + { + "name": "price_base", + "type": "str | None", + "description": "Price base for the data, volume is chain linked volume.", + "default": "current_prices", + "optional": true, + "choices": [ + "current_prices", + "volume" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "current_prices", + "volume" + ] + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdGdpNominal", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country represented by the GDP value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int", + "description": "GDP value for the country and date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdGdpNominal", + "openapi_extra": { + "model": "OecdGdpNominal" + } + }, + "/oecd/gdp_real": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Real GDP data from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.gdp_real(provider='oecd')\nobb.oecd.gdp_real(country='united_states,germany', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Use 'all' to get data for all available countries. Multiple items allowed.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu15", + "eu27", + "euro_area_20_countries", + "finland", + "france", + "g20", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "oecd_26_countries", + "oecd_europe", + "poland", + "portugal", + "romania", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "usmca", + "all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency of the data.", + "default": "quarter", + "optional": true, + "choices": [ + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "quarter", + "annual" + ] + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdGdpReal", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country represented by the Real GDP value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int", + "description": "Real GDP value for the country and date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdGdpReal", + "openapi_extra": { + "model": "OecdGdpReal" + } + }, + "/oecd/gdp_forecast": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Forecasted GDP data from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.gdp_forecast(provider='oecd')\nobb.oecd.gdp_forecast(country='united_states,germany,france', frequency='annual', units='capita', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "Country, or countries, to get forward GDP projections for. Default is all. Multiple items allowed.", + "default": "all", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "dae", + "denmark", + "estonia", + "eu22_oecd", + "euro_area_17_countries", + "finland", + "former_ussr", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "nafta", + "netherlands", + "new_zealand", + "non_oecd_economies", + "norway", + "oecd", + "oecd_asia_oceania", + "opec", + "other_countries", + "other_major_oil", + "other_oil_producers", + "peru", + "poland", + "portugal", + "rest_of_world", + "romania", + "russia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "thailand", + "turkiye", + "united_kingdom", + "united_states", + "world", + "all" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "frequency", + "type": "str | None", + "description": "Frequency of the data, default is annual.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "annual", + "quarter" + ] + } + }, + { + "name": "units", + "type": "str | None", + "description": "Units of the data, default is volume (chain linked volume, 2015).\n'current_prices', 'volume', and 'capita' are expressed in USD; 'growth' as a percent; 'deflator' as an index.", + "default": "volume", + "optional": true, + "choices": [ + "current_prices", + "volume", + "capita", + "growth", + "deflator" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "current_prices", + "volume", + "capita", + "growth", + "deflator" + ] + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdGdpForecast", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "None", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int", + "description": "Forecasted GDP value for the country and date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdGdpForecast", + "openapi_extra": { + "model": "OecdGdpForecast" + } + }, + "/oecd/house_price_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the House Price Index by country from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.house_price_index(provider='oecd')\nobb.oecd.house_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): oecd.", + "default": "united_states", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "choices": [ + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "croatia", + "czechia", + "denmark", + "estonia", + "eu_27", + "euro_area_20_countries", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "quarter", + "optional": true, + "choices": [ + "monthly", + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "monthly", + "quarter", + "annual" + ] + } + }, + { + "name": "transform", + "type": "str | None", + "description": "Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).", + "default": "index", + "optional": true, + "choices": [ + "index", + "yoy", + "period" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "index", + "yoy", + "period" + ] + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data.", + "default": "united_states", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdHousePriceIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Share price index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdHousePriceIndex", + "openapi_extra": { + "model": "OecdHousePriceIndex" + } + }, + "/oecd/share_price_index": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Share Price Index by country from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.share_price_index(provider='oecd')\nobb.oecd.share_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): oecd.", + "default": "united_states", + "optional": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "euro_area_19_countries", + "euro_area_20_countries", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "romania", + "russia", + "saudi_arabia", + "sdr", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "choices": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "euro_area_19_countries", + "euro_area_20_countries", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "romania", + "russia", + "saudi_arabia", + "sdr", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [ + "monthly", + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "monthly", + "quarter", + "annual" + ] + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdSharePriceIndex", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Share price index value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "oecd": [] + }, + "model": "OecdSharePriceIndex", + "openapi_extra": { + "model": "OecdSharePriceIndex" + } + }, + "/oecd/unemployment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get global unemployment data from the OECD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.oecd.unemployment(provider='oecd')\nobb.oecd.unemployment(country='all', frequency='quarter', provider='oecd')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None | list[str | None]", + "description": "The country to get data. Multiple items allowed for provider(s): oecd.", + "default": "united_states", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "oecd": { + "multiple_items_allowed": true, + "choices": [ + "australia", + "austria", + "belgium", + "bulgaria", + "canada", + "chile", + "colombia", + "costa_rica", + "croatia", + "czechia", + "denmark", + "estonia", + "eu27", + "euro_area", + "finland", + "france", + "g7", + "germany", + "greece", + "hungary", + "iceland", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "oecd", + "poland", + "portugal", + "romania", + "slovak_republic", + "slovenia", + "spain", + "sweden", + "switzerland", + "turkiye", + "united_kingdom", + "united_states", + "all" + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "The frequency of the data.", + "default": "monthly", + "optional": true, + "choices": [ + "monthly", + "quarter", + "annual" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "monthly", + "quarter", + "annual" + ] + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "oecd": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data.", + "default": "united_states", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sex", + "type": "str | None", + "description": "Sex to get unemployment for.", + "default": "total", + "optional": true, + "choices": [ + "total", + "male", + "female" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "total", + "male", + "female" + ] + } + }, + { + "name": "age", + "type": "str | None", + "description": "Age group to get unemployment for. Total indicates 15 years or over", + "default": "total", + "optional": true, + "choices": [ + "total", + "15-24", + "25+" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "choices": [ + "total", + "15-24", + "25+" + ] + } + }, + { + "name": "seasonal_adjustment", + "type": "bool | None", + "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OecdUnemployment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country for which unemployment rate is given", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "Unemployment rate, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "oecd": [] + }, + "model": "OecdUnemployment", + "openapi_extra": { + "model": "OecdUnemployment" + } + }, + "/quantitative/normality": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get normality statistics for a data series.\n\nRuns the kurtosis, skewness, Jarque-Bera, Shapiro-Wilk, and Kolmogorov-Smirnov\ntests, each assessing whether the sample is drawn from a normal distribution.\nReturns the test statistic and p-value for every test.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.normality(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NormalityData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "kurtosis_statistic", + "type": "float", + "description": "Kurtosis test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kurtosis_p_value", + "type": "float", + "description": "p-value of the kurtosis test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "skewness_statistic", + "type": "float", + "description": "Skewness test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "skewness_p_value", + "type": "float", + "description": "p-value of the skewness test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "jarque_bera_statistic", + "type": "float", + "description": "Jarque-Bera test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "jarque_bera_p_value", + "type": "float", + "description": "p-value of the Jarque-Bera test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "shapiro_wilk_statistic", + "type": "float", + "description": "Shapiro-Wilk test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "shapiro_wilk_p_value", + "type": "float", + "description": "p-value of the Shapiro-Wilk test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kolmogorov_smirnov_statistic", + "type": "float", + "description": "Kolmogorov-Smirnov test statistic against a normal distribution with the sample mean and variance (Lilliefors test).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kolmogorov_smirnov_p_value", + "type": "float", + "description": "p-value of the Lilliefors-corrected Kolmogorov-Smirnov test, bounded to the range 0.001 to 0.99.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/capm": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Capital Asset Pricing Model (CAPM) risk measures for an asset.\n\nRegresses the asset's excess return on the excess market return using the\nFama-French factors. Returns the market risk (beta), the systematic risk\n(R-squared), and the idiosyncratic risk (1 - R-squared).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.capm(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the price column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CapmData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "market_risk", + "type": "float", + "description": "Beta - the asset's sensitivity to market returns.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "systematic_risk", + "type": "float", + "description": "Share of variance explained by the market (R-squared).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "idiosyncratic_risk", + "type": "float", + "description": "Share of variance not explained by the market (1 - R-squared).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/unitroot_test": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get unit root test results for a data series.\n\nApplies the Augmented Dickey-Fuller (ADF) test, whose null hypothesis is the\npresence of a unit root, and the Kwiatkowski-Phillips-Schmidt-Shin (KPSS) test,\nwhose null hypothesis is stationarity. Together they characterize whether the\nseries is stationary.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.unitroot_test(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "fuller_reg", + "type": "str", + "description": "Constant/trend terms for the ADF test: 'c' constant, 'ct' constant and trend, 'ctt' constant, linear and quadratic trend, 'n' no constant or trend.", + "default": "c", + "optional": true + }, + { + "name": "kpss_reg", + "type": "str", + "description": "Null hypothesis for the KPSS test: 'c' level-stationary, 'ct' trend-stationary.", + "default": "c", + "optional": true + }, + { + "name": "maxlag", + "type": "int", + "description": "Maximum lag for the ADF test. If None, a data-dependent default is used.", + "default": null, + "optional": true + }, + { + "name": "autolag", + "type": "str", + "description": "Lag-selection method for the ADF test: 'AIC', 'BIC', or 't-stat'; None uses maxlag directly without selection.", + "default": "AIC", + "optional": true + }, + { + "name": "nlags", + "type": "int | str", + "description": "Lags for the KPSS variance estimator: 'auto', 'legacy', or an explicit non-negative integer.", + "default": "auto", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UnitRootData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "adf_statistic", + "type": "float", + "description": "Augmented Dickey-Fuller test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_p_value", + "type": "float", + "description": "p-value of the ADF test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_nlags", + "type": "int", + "description": "Number of lags used in the ADF test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_nobs", + "type": "int", + "description": "Number of observations used in the ADF test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_icbest", + "type": "float", + "description": "Best information criterion value of the ADF test (None when autolag is disabled).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "kpss_statistic", + "type": "float", + "description": "KPSS test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_p_value", + "type": "float", + "description": "p-value of the KPSS test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_nlags", + "type": "int", + "description": "Number of lags used in the KPSS test.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_p_value_interpolated", + "type": "bool", + "description": "False when the KPSS p-value is clamped to a table boundary (the true p-value is more extreme than reported).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/summary": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get descriptive summary statistics for a data series.\n\nComputes the count, central tendency, dispersion, and quartile distribution of\nthe target column. Provides a concise profile of the data for initial\nexploration and reporting.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.summary(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SummaryData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "count", + "type": "int", + "description": "Number of observations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mean", + "type": "float", + "description": "Arithmetic mean.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "std", + "type": "float", + "description": "Sample standard deviation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "var", + "type": "float", + "description": "Sample variance.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "min", + "type": "float", + "description": "Minimum value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p25", + "type": "float", + "description": "25th percentile.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p50", + "type": "float", + "description": "50th percentile (median).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p75", + "type": "float", + "description": "75th percentile.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max", + "type": "float", + "description": "Maximum value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/skew": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling skew of a target column over a moving window.\n\nSkew measures the asymmetry of a distribution about its mean. Positive skew\nindicates a longer right tail, while negative skew indicates a longer left tail.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.rolling.skew(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 21, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingSkewData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "skew", + "type": "float", + "description": "Rolling skew value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/variance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling variance of a target column over a moving window.\n\nVariance measures the dispersion of a set of data points around their mean. It is\na key metric for assessing the volatility and stability of a time series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.rolling.variance(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 21, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingVarianceData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "variance", + "type": "float", + "description": "Rolling sample variance value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/stdev": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling standard deviation of a target column over a moving window.\n\nStandard deviation measures the amount of variation or dispersion of a set of\nvalues. It is the square root of the variance and is widely used to assess risk.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.rolling.stdev(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 21, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingStdevData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "stdev", + "type": "float", + "description": "Rolling sample standard deviation value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/kurtosis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling kurtosis of a target column over a moving window.\n\nKurtosis measures the tailedness of a distribution. High kurtosis indicates heavy\ntails and a higher risk of extreme outcomes, while low kurtosis indicates the\nopposite.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.rolling.kurtosis(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 21, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingKurtosisData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kurtosis", + "type": "float", + "description": "Rolling kurtosis value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/mean": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling mean of a target column over a moving window.\n\nThe rolling mean is a simple moving average that smooths short-term fluctuations\nand highlights longer-term trends or cycles in a time series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.rolling.mean(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 21, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingMeanData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mean", + "type": "float", + "description": "Rolling mean value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/quantile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling quantile of a target column over a moving window.\n\nQuantiles divide the range of a distribution into intervals with equal\nprobabilities. This command returns the rolling median alongside the requested\nquantile for analyzing trends, outliers, and risk.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.rolling.quantile(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 21, + "optional": true + }, + { + "name": "quantile_pct", + "type": "float", + "description": "Quantile to compute, between 0 and 1.", + "default": 0.5, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingQuantileData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "median", + "type": "float", + "description": "Rolling median value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "quantile", + "type": "float", + "description": "Rolling quantile value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/rolling/factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Refit factor OLS on a rolling window and emit per-factor betas through time.\n\nFor each window end at stride `step`, runs OLS of the target on the factor\nmatrix using the trailing `window` observations and records each factor's\ncoefficient and t-statistic. Suitable for visualizing time-varying factor\nexposures and detecting regime shifts that named-window decompositions hide.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Roll a 1-year window stepping monthly across a multi-factor regression of `close` on the supplied factor matrix.\nobb.quantitative.rolling.factors(target='close', window=252, step=21, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}], factors_data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Target periodic return series (index column plus the target column).", + "default": null, + "optional": false + }, + { + "name": "factors_data", + "type": "list[Data]", + "description": "Factor return matrix (index column plus one column per factor), in the same units as the target.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the return column in `data` to regress on the factor matrix.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column shared by `data` and `factors_data`.", + "default": "date", + "optional": true + }, + { + "name": "risk_free_column", + "type": "str", + "description": "Optional name of the risk-free rate column in `factors_data`. When provided, the target is regressed in excess form and the column is dropped from the regressors.", + "default": null, + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling regression window.", + "default": 252, + "optional": true + }, + { + "name": "step", + "type": "int", + "description": "Stride between successive windows in observations. A value of 1 refits at every observation; larger values reduce cost on long histories.", + "default": 21, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RollingFactorsData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "End date of the rolling window.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "factor", + "type": "str", + "description": "Factor name (or 'const' for the regression intercept).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "OLS coefficient estimate for the factor at this window end.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "t_statistic", + "type": "float", + "description": "t-statistic for the coefficient at this window end.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/stats/skew": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the skewness of a target column.\n\nSkewness measures the degree of asymmetry of a distribution around its mean.\nPositive skewness indicates a longer right tail, while negative skewness indicates\na longer left tail.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.stats.skew(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StatsSkewData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "skew", + "type": "float", + "description": "Skewness of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/stats/variance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the variance of a target column.\n\nVariance measures the dispersion of a set of data points around their mean. It is a\nkey metric for assessing the volatility and stability of a time series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.stats.variance(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StatsVarianceData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "variance", + "type": "float", + "description": "Sample variance of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/stats/stdev": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the standard deviation of a target column.\n\nStandard deviation measures the amount of variation or dispersion of a set of\nvalues and is the square root of the variance. It is widely used to assess risk\nand volatility.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.stats.stdev(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StatsStdevData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "stdev", + "type": "float", + "description": "Sample standard deviation of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/stats/kurtosis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the kurtosis of a target column.\n\nKurtosis measures the tailedness of a distribution. High kurtosis indicates heavy\ntails and a higher risk of extreme outcomes, while low kurtosis indicates lighter\ntails.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.stats.kurtosis(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StatsKurtosisData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "kurtosis", + "type": "float", + "description": "Kurtosis of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/stats/mean": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the arithmetic mean of a target column.\n\nThe mean is the average of a set of values and is widely used to summarize the\ncentral tendency of a time series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.stats.mean(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StatsMeanData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "mean", + "type": "float", + "description": "Arithmetic mean of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/stats/quantile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the quantile of a target column at a specified percentage.\n\nQuantiles are points dividing the range of a distribution into intervals with equal\nprobabilities. The median (0.5 quantile) is returned alongside the requested\nquantile.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.stats.quantile(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the column to analyze.", + "default": null, + "optional": false + }, + { + "name": "quantile_pct", + "type": "float", + "description": "Quantile to compute, between 0 and 1.", + "default": 0.5, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StatsQuantileData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "median", + "type": "float", + "description": "Median (0.5 quantile) of the distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "quantile", + "type": "float", + "description": "Value at the requested quantile.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/performance/omega_ratio": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Omega ratio of a periodic return series across return thresholds.\n\nThe Omega ratio measures the probability-weighted gains above a threshold relative\nto the losses below it. Each annualized threshold is converted to a per-period\nthreshold assuming 252 periods per year. The ratio is evaluated at `bins`\nthresholds spanning the requested range, giving a profile of risk and reward\nrather than a single number.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.performance.omega_ratio(target='return', data=[{'date': '2023-01-02', 'return': 0.01}, {'date': '2023-01-03', 'return': 0.01}, {'date': '2023-01-04', 'return': 0.01}, {'date': '2023-01-05', 'return': 0.01}, {'date': '2023-01-06', 'return': 0.01}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the periodic return column to analyze.", + "default": null, + "optional": false + }, + { + "name": "threshold_start", + "type": "float", + "description": "Lower bound of the annualized return-threshold range, as a decimal fraction.", + "default": 0.0, + "optional": true + }, + { + "name": "threshold_end", + "type": "float", + "description": "Upper bound of the annualized return-threshold range, as a decimal fraction.", + "default": 1.5, + "optional": true + }, + { + "name": "bins", + "type": "int", + "description": "Number of evenly spaced thresholds to evaluate.", + "default": 50, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[OmegaRatioData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "threshold", + "type": "float", + "description": "Annualized return threshold the ratio is evaluated at.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "omega", + "type": "float", + "description": "Omega ratio at the threshold.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/performance/sharpe_ratio": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling annualized Sharpe ratio of a price series.\n\nThe prices are converted to periodic returns. In each rolling window, the mean\nreturn in excess of the risk-free rate is divided by the standard deviation of\nthe returns and annualized assuming 252 periods per year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.performance.sharpe_ratio(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the price column to analyze.", + "default": null, + "optional": false + }, + { + "name": "rfr", + "type": "float", + "description": "Annualized risk-free rate, as a decimal fraction.", + "default": 0.0, + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 252, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[SharpeRatioData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sharpe_ratio", + "type": "float", + "description": "Rolling annualized Sharpe ratio.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/performance/sortino_ratio": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the rolling annualized Sortino ratio of a price series.\n\nThe prices are converted to periodic returns. In each rolling window, the mean\nreturn in excess of the minimum acceptable return is divided by the downside\ndeviation below that return and annualized assuming 252 periods per year. When\nadjusted, the ratio is scaled by 1/sqrt(2) so it can be compared directly with\nthe Sharpe ratio.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.performance.sortino_ratio(target='close', window=20, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input dataset.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the price column to analyze.", + "default": null, + "optional": false + }, + { + "name": "target_return", + "type": "float", + "description": "Annualized minimum acceptable return, as a decimal fraction.", + "default": 0.0, + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Number of observations in each rolling window.", + "default": 252, + "optional": true + }, + { + "name": "adjusted", + "type": "bool", + "description": "When true, scale the ratio by 1/sqrt(2) for comparability with the Sharpe ratio.", + "default": false, + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column.", + "default": "date", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[SortinoRatioData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sortino_ratio", + "type": "float", + "description": "Rolling annualized Sortino ratio.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Regress a target return series on a factor matrix across named periods.\n\nAligns `data` and `factors_data` on their shared index, optionally subtracts a\nrisk-free column from the target, then runs an OLS regression of the target on\nthe factor columns (plus an intercept) for each named look-back period. Returns\none row per (`period`, `factor`) with the OLS coefficient, p-value, 95%\nconfidence interval, and the period's R-squared.\n\nDesigned to be paired with any factor provider; for Fama-French data, pipe the\n`openbb-famafrench` provider's output into `factors_data`.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.factors(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}], factors_data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Target periodic return series (index column plus the target column).", + "default": null, + "optional": false + }, + { + "name": "factors_data", + "type": "list[Data]", + "description": "Factor return matrix (index column plus one column per factor), in the same units as the target.", + "default": null, + "optional": false + }, + { + "name": "periods", + "type": "list[str]", + "description": "Named look-back periods to regress over, anchored to the latest factor observation. Supported values: '1 Month', '3 Month', 'YTD', '1 Year', '3 Year', 'Max'.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the return column in `data` to regress on the factor matrix.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column shared by `data` and `factors_data`.", + "default": "date", + "optional": true + }, + { + "name": "risk_free_column", + "type": "str", + "description": "Optional name of the risk-free rate column in `factors_data`. When provided, the target is regressed in excess form (target minus the risk-free column) and the column itself is dropped from the regressors.", + "default": null, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[FactorRegressionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "str", + "description": "Look-back period the regression was run over.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "factor", + "type": "str", + "description": "Factor name (or 'const' for the regression intercept).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "OLS coefficient estimate for the factor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "p_value", + "type": "float", + "description": "Two-sided p-value of the coefficient estimate.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lower_ci", + "type": "float", + "description": "Lower bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "upper_ci", + "type": "float", + "description": "Upper bound of the 95% confidence interval.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "r_squared", + "type": "float", + "description": "R-squared of the regression for this period (repeated per row).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/risk_decomposition": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Decompose Var(target) into per-factor contributions plus residual variance.\n\nFor each look-back period, runs OLS of the target on the factor matrix and\nsplits the target's variance via the additive identity\n`Var(target) = sum_i beta_i * Cov(factor_i, target) + Var(residual)`.\nReturned shares sum to 1 per period: factor shares sum to R^2 and the residual\nrow holds `1 - R^2`. Handles correlated factors cleanly because each share is\nmeasured by the covariance with the target rather than by the factor's\nstandalone variance.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.risk_decomposition(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}], factors_data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Target periodic return series (index column plus the target column).", + "default": null, + "optional": false + }, + { + "name": "factors_data", + "type": "list[Data]", + "description": "Factor return matrix (index column plus one column per factor), in the same units as the target.", + "default": null, + "optional": false + }, + { + "name": "periods", + "type": "list[str]", + "description": "Named look-back periods to decompose over, anchored to the latest factor observation.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the return column in `data` to decompose against the factors.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column shared by `data` and `factors_data`.", + "default": "date", + "optional": true + }, + { + "name": "risk_free_column", + "type": "str", + "description": "Optional name of the risk-free rate column in `factors_data`. When provided, the target is converted to excess returns before decomposition and the column is dropped from the factor set.", + "default": null, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RiskDecompositionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "str", + "description": "Look-back period the decomposition was run over.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "factor", + "type": "str", + "description": "Factor name, or 'Residual' for the idiosyncratic component.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "contribution", + "type": "float", + "description": "Covariance-based contribution to Var(target): for a factor, beta_i * Cov(factor_i, target); for 'Residual', Var(target) * (1 - R^2).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "share", + "type": "float", + "description": "Fraction of Var(target) attributed to this factor (or to the residual). Factor shares sum to R^2; the residual share equals 1 - R^2.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/quantitative/attribution": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Decompose the target's total return into per-factor contributions plus alpha\nand residual.\n\nFor each look-back period, runs OLS of the target on the factor matrix and\nsplits the period's cumulative target return via the identity\n`sum_t y_t = alpha * n + sum_i beta_i * sum_t f_{i,t} + sum_t residual_t`.\nThe three components are returned as rows: one per factor, one `Alpha`, and one\n`Residual`. Use with arithmetic (additive) returns; for geometric compounding,\nconvert returns to log-returns before passing in.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.quantitative.attribution(target='close', data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}], factors_data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}, {'date': '2023-01-07', 'open': 128.33, 'high': 140.0, 'low': 116.67, 'close': 134.17, 'volume': 11666.67}, {'date': '2023-01-08', 'open': 125.71, 'high': 137.14, 'low': 114.29, 'close': 131.43, 'volume': 11428.57}, {'date': '2023-01-09', 'open': 123.75, 'high': 135.0, 'low': 112.5, 'close': 129.38, 'volume': 11250.0}, {'date': '2023-01-10', 'open': 122.22, 'high': 133.33, 'low': 111.11, 'close': 127.78, 'volume': 11111.11}, {'date': '2023-01-11', 'open': 121.0, 'high': 132.0, 'low': 110.0, 'close': 126.5, 'volume': 11000.0}, {'date': '2023-01-12', 'open': 120.0, 'high': 130.91, 'low': 109.09, 'close': 125.45, 'volume': 10909.09}, {'date': '2023-01-13', 'open': 119.17, 'high': 130.0, 'low': 108.33, 'close': 124.58, 'volume': 10833.33}, {'date': '2023-01-14', 'open': 118.46, 'high': 129.23, 'low': 107.69, 'close': 123.85, 'volume': 10769.23}, {'date': '2023-01-15', 'open': 117.86, 'high': 128.57, 'low': 107.14, 'close': 123.21, 'volume': 10714.29}, {'date': '2023-01-16', 'open': 117.33, 'high': 128.0, 'low': 106.67, 'close': 122.67, 'volume': 10666.67}, {'date': '2023-01-17', 'open': 116.88, 'high': 127.5, 'low': 106.25, 'close': 122.19, 'volume': 10625.0}, {'date': '2023-01-18', 'open': 116.47, 'high': 127.06, 'low': 105.88, 'close': 121.76, 'volume': 10588.24}, {'date': '2023-01-19', 'open': 116.11, 'high': 126.67, 'low': 105.56, 'close': 121.39, 'volume': 10555.56}, {'date': '2023-01-20', 'open': 115.79, 'high': 126.32, 'low': 105.26, 'close': 121.05, 'volume': 10526.32}, {'date': '2023-01-21', 'open': 115.5, 'high': 126.0, 'low': 105.0, 'close': 120.75, 'volume': 10500.0}, {'date': '2023-01-22', 'open': 115.24, 'high': 125.71, 'low': 104.76, 'close': 120.48, 'volume': 10476.19}, {'date': '2023-01-23', 'open': 115.0, 'high': 125.45, 'low': 104.55, 'close': 120.23, 'volume': 10454.55}, {'date': '2023-01-24', 'open': 114.78, 'high': 125.22, 'low': 104.35, 'close': 120.0, 'volume': 10434.78}, {'date': '2023-01-25', 'open': 114.58, 'high': 125.0, 'low': 104.17, 'close': 119.79, 'volume': 10416.67}, {'date': '2023-01-26', 'open': 114.4, 'high': 124.8, 'low': 104.0, 'close': 119.6, 'volume': 10400.0}, {'date': '2023-01-27', 'open': 114.23, 'high': 124.62, 'low': 103.85, 'close': 119.42, 'volume': 10384.62}, {'date': '2023-01-28', 'open': 114.07, 'high': 124.44, 'low': 103.7, 'close': 119.26, 'volume': 10370.37}, {'date': '2023-01-29', 'open': 113.93, 'high': 124.29, 'low': 103.57, 'close': 119.11, 'volume': 10357.14}, {'date': '2023-01-30', 'open': 113.79, 'high': 124.14, 'low': 103.45, 'close': 118.97, 'volume': 10344.83}, {'date': '2023-01-31', 'open': 113.67, 'high': 124.0, 'low': 103.33, 'close': 118.83, 'volume': 10333.33}, {'date': '2023-02-01', 'open': 113.55, 'high': 123.87, 'low': 103.23, 'close': 118.71, 'volume': 10322.58}, {'date': '2023-02-02', 'open': 113.44, 'high': 123.75, 'low': 103.12, 'close': 118.59, 'volume': 10312.5}, {'date': '2023-02-03', 'open': 113.33, 'high': 123.64, 'low': 103.03, 'close': 118.48, 'volume': 10303.03}, {'date': '2023-02-04', 'open': 113.24, 'high': 123.53, 'low': 102.94, 'close': 118.38, 'volume': 10294.12}, {'date': '2023-02-05', 'open': 113.14, 'high': 123.43, 'low': 102.86, 'close': 118.29, 'volume': 10285.71}, {'date': '2023-02-06', 'open': 113.06, 'high': 123.33, 'low': 102.78, 'close': 118.19, 'volume': 10277.78}, {'date': '2023-02-07', 'open': 112.97, 'high': 123.24, 'low': 102.7, 'close': 118.11, 'volume': 10270.27}, {'date': '2023-02-08', 'open': 112.89, 'high': 123.16, 'low': 102.63, 'close': 118.03, 'volume': 10263.16}, {'date': '2023-02-09', 'open': 112.82, 'high': 123.08, 'low': 102.56, 'close': 117.95, 'volume': 10256.41}, {'date': '2023-02-10', 'open': 112.75, 'high': 123.0, 'low': 102.5, 'close': 117.87, 'volume': 10250.0}, {'date': '2023-02-11', 'open': 112.68, 'high': 122.93, 'low': 102.44, 'close': 117.8, 'volume': 10243.9}, {'date': '2023-02-12', 'open': 112.62, 'high': 122.86, 'low': 102.38, 'close': 117.74, 'volume': 10238.1}, {'date': '2023-02-13', 'open': 112.56, 'high': 122.79, 'low': 102.33, 'close': 117.67, 'volume': 10232.56}, {'date': '2023-02-14', 'open': 112.5, 'high': 122.73, 'low': 102.27, 'close': 117.61, 'volume': 10227.27}, {'date': '2023-02-15', 'open': 112.44, 'high': 122.67, 'low': 102.22, 'close': 117.56, 'volume': 10222.22}, {'date': '2023-02-16', 'open': 112.39, 'high': 122.61, 'low': 102.17, 'close': 117.5, 'volume': 10217.39}, {'date': '2023-02-17', 'open': 112.34, 'high': 122.55, 'low': 102.13, 'close': 117.45, 'volume': 10212.77}, {'date': '2023-02-18', 'open': 112.29, 'high': 122.5, 'low': 102.08, 'close': 117.4, 'volume': 10208.33}, {'date': '2023-02-19', 'open': 112.24, 'high': 122.45, 'low': 102.04, 'close': 117.35, 'volume': 10204.08}, {'date': '2023-02-20', 'open': 112.2, 'high': 122.4, 'low': 102.0, 'close': 117.3, 'volume': 10200.0}, {'date': '2023-02-21', 'open': 112.16, 'high': 122.35, 'low': 101.96, 'close': 117.25, 'volume': 10196.08}, {'date': '2023-02-22', 'open': 112.12, 'high': 122.31, 'low': 101.92, 'close': 117.21, 'volume': 10192.31}, {'date': '2023-02-23', 'open': 112.08, 'high': 122.26, 'low': 101.89, 'close': 117.17, 'volume': 10188.68}, {'date': '2023-02-24', 'open': 112.04, 'high': 122.22, 'low': 101.85, 'close': 117.13, 'volume': 10185.19}, {'date': '2023-02-25', 'open': 112.0, 'high': 122.18, 'low': 101.82, 'close': 117.09, 'volume': 10181.82}, {'date': '2023-02-26', 'open': 111.96, 'high': 122.14, 'low': 101.79, 'close': 117.05, 'volume': 10178.57}, {'date': '2023-02-27', 'open': 111.93, 'high': 122.11, 'low': 101.75, 'close': 117.02, 'volume': 10175.44}, {'date': '2023-02-28', 'open': 111.9, 'high': 122.07, 'low': 101.72, 'close': 116.98, 'volume': 10172.41}, {'date': '2023-03-01', 'open': 111.86, 'high': 122.03, 'low': 101.69, 'close': 116.95, 'volume': 10169.49}, {'date': '2023-03-02', 'open': 111.83, 'high': 122.0, 'low': 101.67, 'close': 116.92, 'volume': 10166.67}, {'date': '2023-03-03', 'open': 111.8, 'high': 121.97, 'low': 101.64, 'close': 116.89, 'volume': 10163.93}, {'date': '2023-03-04', 'open': 111.77, 'high': 121.94, 'low': 101.61, 'close': 116.85, 'volume': 10161.29}, {'date': '2023-03-05', 'open': 111.75, 'high': 121.9, 'low': 101.59, 'close': 116.83, 'volume': 10158.73}, {'date': '2023-03-06', 'open': 111.72, 'high': 121.88, 'low': 101.56, 'close': 116.8, 'volume': 10156.25}, {'date': '2023-03-07', 'open': 111.69, 'high': 121.85, 'low': 101.54, 'close': 116.77, 'volume': 10153.85}, {'date': '2023-03-08', 'open': 111.67, 'high': 121.82, 'low': 101.52, 'close': 116.74, 'volume': 10151.52}, {'date': '2023-03-09', 'open': 111.64, 'high': 121.79, 'low': 101.49, 'close': 116.72, 'volume': 10149.25}, {'date': '2023-03-10', 'open': 111.62, 'high': 121.76, 'low': 101.47, 'close': 116.69, 'volume': 10147.06}, {'date': '2023-03-11', 'open': 111.59, 'high': 121.74, 'low': 101.45, 'close': 116.67, 'volume': 10144.93}, {'date': '2023-03-12', 'open': 111.57, 'high': 121.71, 'low': 101.43, 'close': 116.64, 'volume': 10142.86}, {'date': '2023-03-13', 'open': 111.55, 'high': 121.69, 'low': 101.41, 'close': 116.62, 'volume': 10140.85}, {'date': '2023-03-14', 'open': 111.53, 'high': 121.67, 'low': 101.39, 'close': 116.6, 'volume': 10138.89}, {'date': '2023-03-15', 'open': 111.51, 'high': 121.64, 'low': 101.37, 'close': 116.58, 'volume': 10136.99}, {'date': '2023-03-16', 'open': 111.49, 'high': 121.62, 'low': 101.35, 'close': 116.55, 'volume': 10135.14}, {'date': '2023-03-17', 'open': 111.47, 'high': 121.6, 'low': 101.33, 'close': 116.53, 'volume': 10133.33}, {'date': '2023-03-18', 'open': 111.45, 'high': 121.58, 'low': 101.32, 'close': 116.51, 'volume': 10131.58}, {'date': '2023-03-19', 'open': 111.43, 'high': 121.56, 'low': 101.3, 'close': 116.49, 'volume': 10129.87}, {'date': '2023-03-20', 'open': 111.41, 'high': 121.54, 'low': 101.28, 'close': 116.47, 'volume': 10128.21}, {'date': '2023-03-21', 'open': 111.39, 'high': 121.52, 'low': 101.27, 'close': 116.46, 'volume': 10126.58}, {'date': '2023-03-22', 'open': 111.38, 'high': 121.5, 'low': 101.25, 'close': 116.44, 'volume': 10125.0}, {'date': '2023-03-23', 'open': 111.36, 'high': 121.48, 'low': 101.23, 'close': 116.42, 'volume': 10123.46}, {'date': '2023-03-24', 'open': 111.34, 'high': 121.46, 'low': 101.22, 'close': 116.4, 'volume': 10121.95}, {'date': '2023-03-25', 'open': 111.33, 'high': 121.45, 'low': 101.2, 'close': 116.39, 'volume': 10120.48}, {'date': '2023-03-26', 'open': 111.31, 'high': 121.43, 'low': 101.19, 'close': 116.37, 'volume': 10119.05}, {'date': '2023-03-27', 'open': 111.29, 'high': 121.41, 'low': 101.18, 'close': 116.35, 'volume': 10117.65}, {'date': '2023-03-28', 'open': 111.28, 'high': 121.4, 'low': 101.16, 'close': 116.34, 'volume': 10116.28}, {'date': '2023-03-29', 'open': 111.26, 'high': 121.38, 'low': 101.15, 'close': 116.32, 'volume': 10114.94}, {'date': '2023-03-30', 'open': 111.25, 'high': 121.36, 'low': 101.14, 'close': 116.31, 'volume': 10113.64}, {'date': '2023-03-31', 'open': 111.24, 'high': 121.35, 'low': 101.12, 'close': 116.29, 'volume': 10112.36}, {'date': '2023-04-01', 'open': 111.22, 'high': 121.33, 'low': 101.11, 'close': 116.28, 'volume': 10111.11}, {'date': '2023-04-02', 'open': 111.21, 'high': 121.32, 'low': 101.1, 'close': 116.26, 'volume': 10109.89}, {'date': '2023-04-03', 'open': 111.2, 'high': 121.3, 'low': 101.09, 'close': 116.25, 'volume': 10108.7}, {'date': '2023-04-04', 'open': 111.18, 'high': 121.29, 'low': 101.08, 'close': 116.24, 'volume': 10107.53}, {'date': '2023-04-05', 'open': 111.17, 'high': 121.28, 'low': 101.06, 'close': 116.22, 'volume': 10106.38}, {'date': '2023-04-06', 'open': 111.16, 'high': 121.26, 'low': 101.05, 'close': 116.21, 'volume': 10105.26}, {'date': '2023-04-07', 'open': 111.15, 'high': 121.25, 'low': 101.04, 'close': 116.2, 'volume': 10104.17}, {'date': '2023-04-08', 'open': 111.13, 'high': 121.24, 'low': 101.03, 'close': 116.19, 'volume': 10103.09}, {'date': '2023-04-09', 'open': 111.12, 'high': 121.22, 'low': 101.02, 'close': 116.17, 'volume': 10102.04}, {'date': '2023-04-10', 'open': 111.11, 'high': 121.21, 'low': 101.01, 'close': 116.16, 'volume': 10101.01}, {'date': '2023-04-11', 'open': 111.1, 'high': 121.2, 'low': 101.0, 'close': 116.15, 'volume': 10100.0}, {'date': '2023-04-12', 'open': 111.09, 'high': 121.19, 'low': 100.99, 'close': 116.14, 'volume': 10099.01}, {'date': '2023-04-13', 'open': 111.08, 'high': 121.18, 'low': 100.98, 'close': 116.13, 'volume': 10098.04}, {'date': '2023-04-14', 'open': 111.07, 'high': 121.17, 'low': 100.97, 'close': 116.12, 'volume': 10097.09}, {'date': '2023-04-15', 'open': 111.06, 'high': 121.15, 'low': 100.96, 'close': 116.11, 'volume': 10096.15}, {'date': '2023-04-16', 'open': 111.05, 'high': 121.14, 'low': 100.95, 'close': 116.1, 'volume': 10095.24}, {'date': '2023-04-17', 'open': 111.04, 'high': 121.13, 'low': 100.94, 'close': 116.08, 'volume': 10094.34}, {'date': '2023-04-18', 'open': 111.03, 'high': 121.12, 'low': 100.93, 'close': 116.07, 'volume': 10093.46}, {'date': '2023-04-19', 'open': 111.02, 'high': 121.11, 'low': 100.93, 'close': 116.06, 'volume': 10092.59}, {'date': '2023-04-20', 'open': 111.01, 'high': 121.1, 'low': 100.92, 'close': 116.06, 'volume': 10091.74}, {'date': '2023-04-21', 'open': 111.0, 'high': 121.09, 'low': 100.91, 'close': 116.05, 'volume': 10090.91}, {'date': '2023-04-22', 'open': 110.99, 'high': 121.08, 'low': 100.9, 'close': 116.04, 'volume': 10090.09}, {'date': '2023-04-23', 'open': 110.98, 'high': 121.07, 'low': 100.89, 'close': 116.03, 'volume': 10089.29}, {'date': '2023-04-24', 'open': 110.97, 'high': 121.06, 'low': 100.88, 'close': 116.02, 'volume': 10088.5}, {'date': '2023-04-25', 'open': 110.96, 'high': 121.05, 'low': 100.88, 'close': 116.01, 'volume': 10087.72}, {'date': '2023-04-26', 'open': 110.96, 'high': 121.04, 'low': 100.87, 'close': 116.0, 'volume': 10086.96}, {'date': '2023-04-27', 'open': 110.95, 'high': 121.03, 'low': 100.86, 'close': 115.99, 'volume': 10086.21}, {'date': '2023-04-28', 'open': 110.94, 'high': 121.03, 'low': 100.85, 'close': 115.98, 'volume': 10085.47}, {'date': '2023-04-29', 'open': 110.93, 'high': 121.02, 'low': 100.85, 'close': 115.97, 'volume': 10084.75}, {'date': '2023-04-30', 'open': 110.92, 'high': 121.01, 'low': 100.84, 'close': 115.97, 'volume': 10084.03}, {'date': '2023-05-01', 'open': 110.92, 'high': 121.0, 'low': 100.83, 'close': 115.96, 'volume': 10083.33}, {'date': '2023-05-02', 'open': 110.91, 'high': 120.99, 'low': 100.83, 'close': 115.95, 'volume': 10082.64}, {'date': '2023-05-03', 'open': 110.9, 'high': 120.98, 'low': 100.82, 'close': 115.94, 'volume': 10081.97}, {'date': '2023-05-04', 'open': 110.89, 'high': 120.98, 'low': 100.81, 'close': 115.93, 'volume': 10081.3}, {'date': '2023-05-05', 'open': 110.89, 'high': 120.97, 'low': 100.81, 'close': 115.93, 'volume': 10080.65}, {'date': '2023-05-06', 'open': 110.88, 'high': 120.96, 'low': 100.8, 'close': 115.92, 'volume': 10080.0}, {'date': '2023-05-07', 'open': 110.87, 'high': 120.95, 'low': 100.79, 'close': 115.91, 'volume': 10079.37}, {'date': '2023-05-08', 'open': 110.87, 'high': 120.94, 'low': 100.79, 'close': 115.91, 'volume': 10078.74}, {'date': '2023-05-09', 'open': 110.86, 'high': 120.94, 'low': 100.78, 'close': 115.9, 'volume': 10078.12}, {'date': '2023-05-10', 'open': 110.85, 'high': 120.93, 'low': 100.78, 'close': 115.89, 'volume': 10077.52}, {'date': '2023-05-11', 'open': 110.85, 'high': 120.92, 'low': 100.77, 'close': 115.88, 'volume': 10076.92}, {'date': '2023-05-12', 'open': 110.84, 'high': 120.92, 'low': 100.76, 'close': 115.88, 'volume': 10076.34}, {'date': '2023-05-13', 'open': 110.83, 'high': 120.91, 'low': 100.76, 'close': 115.87, 'volume': 10075.76}, {'date': '2023-05-14', 'open': 110.83, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10075.19}, {'date': '2023-05-15', 'open': 110.82, 'high': 120.9, 'low': 100.75, 'close': 115.86, 'volume': 10074.63}, {'date': '2023-05-16', 'open': 110.81, 'high': 120.89, 'low': 100.74, 'close': 115.85, 'volume': 10074.07}, {'date': '2023-05-17', 'open': 110.81, 'high': 120.88, 'low': 100.74, 'close': 115.85, 'volume': 10073.53}, {'date': '2023-05-18', 'open': 110.8, 'high': 120.88, 'low': 100.73, 'close': 115.84, 'volume': 10072.99}, {'date': '2023-05-19', 'open': 110.8, 'high': 120.87, 'low': 100.72, 'close': 115.83, 'volume': 10072.46}, {'date': '2023-05-20', 'open': 110.79, 'high': 120.86, 'low': 100.72, 'close': 115.83, 'volume': 10071.94}, {'date': '2023-05-21', 'open': 110.79, 'high': 120.86, 'low': 100.71, 'close': 115.82, 'volume': 10071.43}, {'date': '2023-05-22', 'open': 110.78, 'high': 120.85, 'low': 100.71, 'close': 115.82, 'volume': 10070.92}, {'date': '2023-05-23', 'open': 110.77, 'high': 120.85, 'low': 100.7, 'close': 115.81, 'volume': 10070.42}, {'date': '2023-05-24', 'open': 110.77, 'high': 120.84, 'low': 100.7, 'close': 115.8, 'volume': 10069.93}, {'date': '2023-05-25', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.8, 'volume': 10069.44}, {'date': '2023-05-26', 'open': 110.76, 'high': 120.83, 'low': 100.69, 'close': 115.79, 'volume': 10068.97}, {'date': '2023-05-27', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.79, 'volume': 10068.49}, {'date': '2023-05-28', 'open': 110.75, 'high': 120.82, 'low': 100.68, 'close': 115.78, 'volume': 10068.03}, {'date': '2023-05-29', 'open': 110.74, 'high': 120.81, 'low': 100.68, 'close': 115.78, 'volume': 10067.57}, {'date': '2023-05-30', 'open': 110.74, 'high': 120.81, 'low': 100.67, 'close': 115.77, 'volume': 10067.11}, {'date': '2023-05-31', 'open': 110.73, 'high': 120.8, 'low': 100.67, 'close': 115.77, 'volume': 10066.67}, {'date': '2023-06-01', 'open': 110.73, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10066.23}, {'date': '2023-06-02', 'open': 110.72, 'high': 120.79, 'low': 100.66, 'close': 115.76, 'volume': 10065.79}, {'date': '2023-06-03', 'open': 110.72, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10065.36}, {'date': '2023-06-04', 'open': 110.71, 'high': 120.78, 'low': 100.65, 'close': 115.75, 'volume': 10064.94}, {'date': '2023-06-05', 'open': 110.71, 'high': 120.77, 'low': 100.65, 'close': 115.74, 'volume': 10064.52}, {'date': '2023-06-06', 'open': 110.71, 'high': 120.77, 'low': 100.64, 'close': 115.74, 'volume': 10064.1}, {'date': '2023-06-07', 'open': 110.7, 'high': 120.76, 'low': 100.64, 'close': 115.73, 'volume': 10063.69}, {'date': '2023-06-08', 'open': 110.7, 'high': 120.76, 'low': 100.63, 'close': 115.73, 'volume': 10063.29}, {'date': '2023-06-09', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.89}, {'date': '2023-06-10', 'open': 110.69, 'high': 120.75, 'low': 100.63, 'close': 115.72, 'volume': 10062.5}, {'date': '2023-06-11', 'open': 110.68, 'high': 120.75, 'low': 100.62, 'close': 115.71, 'volume': 10062.11}, {'date': '2023-06-12', 'open': 110.68, 'high': 120.74, 'low': 100.62, 'close': 115.71, 'volume': 10061.73}, {'date': '2023-06-13', 'open': 110.67, 'high': 120.74, 'low': 100.61, 'close': 115.71, 'volume': 10061.35}, {'date': '2023-06-14', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.98}, {'date': '2023-06-15', 'open': 110.67, 'high': 120.73, 'low': 100.61, 'close': 115.7, 'volume': 10060.61}, {'date': '2023-06-16', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10060.24}, {'date': '2023-06-17', 'open': 110.66, 'high': 120.72, 'low': 100.6, 'close': 115.69, 'volume': 10059.88}, {'date': '2023-06-18', 'open': 110.65, 'high': 120.71, 'low': 100.6, 'close': 115.68, 'volume': 10059.52}, {'date': '2023-06-19', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10059.17}, {'date': '2023-06-20', 'open': 110.65, 'high': 120.71, 'low': 100.59, 'close': 115.68, 'volume': 10058.82}, {'date': '2023-06-21', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.48}, {'date': '2023-06-22', 'open': 110.64, 'high': 120.7, 'low': 100.58, 'close': 115.67, 'volume': 10058.14}, {'date': '2023-06-23', 'open': 110.64, 'high': 120.69, 'low': 100.58, 'close': 115.66, 'volume': 10057.8}, {'date': '2023-06-24', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.47}, {'date': '2023-06-25', 'open': 110.63, 'high': 120.69, 'low': 100.57, 'close': 115.66, 'volume': 10057.14}, {'date': '2023-06-26', 'open': 110.62, 'high': 120.68, 'low': 100.57, 'close': 115.65, 'volume': 10056.82}, {'date': '2023-06-27', 'open': 110.62, 'high': 120.68, 'low': 100.56, 'close': 115.65, 'volume': 10056.5}, {'date': '2023-06-28', 'open': 110.62, 'high': 120.67, 'low': 100.56, 'close': 115.65, 'volume': 10056.18}, {'date': '2023-06-29', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.87}, {'date': '2023-06-30', 'open': 110.61, 'high': 120.67, 'low': 100.56, 'close': 115.64, 'volume': 10055.56}, {'date': '2023-07-01', 'open': 110.61, 'high': 120.66, 'low': 100.55, 'close': 115.64, 'volume': 10055.25}, {'date': '2023-07-02', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.95}, {'date': '2023-07-03', 'open': 110.6, 'high': 120.66, 'low': 100.55, 'close': 115.63, 'volume': 10054.64}, {'date': '2023-07-04', 'open': 110.6, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.35}, {'date': '2023-07-05', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10054.05}, {'date': '2023-07-06', 'open': 110.59, 'high': 120.65, 'low': 100.54, 'close': 115.62, 'volume': 10053.76}, {'date': '2023-07-07', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.48}, {'date': '2023-07-08', 'open': 110.59, 'high': 120.64, 'low': 100.53, 'close': 115.61, 'volume': 10053.19}, {'date': '2023-07-09', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.91}, {'date': '2023-07-10', 'open': 110.58, 'high': 120.63, 'low': 100.53, 'close': 115.61, 'volume': 10052.63}, {'date': '2023-07-11', 'open': 110.58, 'high': 120.63, 'low': 100.52, 'close': 115.6, 'volume': 10052.36}, {'date': '2023-07-12', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10052.08}, {'date': '2023-07-13', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.6, 'volume': 10051.81}, {'date': '2023-07-14', 'open': 110.57, 'high': 120.62, 'low': 100.52, 'close': 115.59, 'volume': 10051.55}, {'date': '2023-07-15', 'open': 110.56, 'high': 120.62, 'low': 100.51, 'close': 115.59, 'volume': 10051.28}, {'date': '2023-07-16', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.59, 'volume': 10051.02}, {'date': '2023-07-17', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.76}, {'date': '2023-07-18', 'open': 110.56, 'high': 120.61, 'low': 100.51, 'close': 115.58, 'volume': 10050.51}, {'date': '2023-07-19', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.58, 'volume': 10050.25}, {'date': '2023-07-20', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10050.0}, {'date': '2023-07-21', 'open': 110.55, 'high': 120.6, 'low': 100.5, 'close': 115.57, 'volume': 10049.75}, {'date': '2023-07-22', 'open': 110.54, 'high': 120.59, 'low': 100.5, 'close': 115.57, 'volume': 10049.5}, {'date': '2023-07-23', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.57, 'volume': 10049.26}, {'date': '2023-07-24', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10049.02}, {'date': '2023-07-25', 'open': 110.54, 'high': 120.59, 'low': 100.49, 'close': 115.56, 'volume': 10048.78}, {'date': '2023-07-26', 'open': 110.53, 'high': 120.58, 'low': 100.49, 'close': 115.56, 'volume': 10048.54}, {'date': '2023-07-27', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.56, 'volume': 10048.31}, {'date': '2023-07-28', 'open': 110.53, 'high': 120.58, 'low': 100.48, 'close': 115.55, 'volume': 10048.08}, {'date': '2023-07-29', 'open': 110.53, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.85}, {'date': '2023-07-30', 'open': 110.52, 'high': 120.57, 'low': 100.48, 'close': 115.55, 'volume': 10047.62}, {'date': '2023-07-31', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.55, 'volume': 10047.39}, {'date': '2023-08-01', 'open': 110.52, 'high': 120.57, 'low': 100.47, 'close': 115.54, 'volume': 10047.17}, {'date': '2023-08-02', 'open': 110.52, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.95}, {'date': '2023-08-03', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.54, 'volume': 10046.73}, {'date': '2023-08-04', 'open': 110.51, 'high': 120.56, 'low': 100.47, 'close': 115.53, 'volume': 10046.51}, {'date': '2023-08-05', 'open': 110.51, 'high': 120.56, 'low': 100.46, 'close': 115.53, 'volume': 10046.3}, {'date': '2023-08-06', 'open': 110.51, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10046.08}, {'date': '2023-08-07', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.87}, {'date': '2023-08-08', 'open': 110.5, 'high': 120.55, 'low': 100.46, 'close': 115.53, 'volume': 10045.66}, {'date': '2023-08-09', 'open': 110.5, 'high': 120.55, 'low': 100.45, 'close': 115.52, 'volume': 10045.45}, {'date': '2023-08-10', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.25}, {'date': '2023-08-11', 'open': 110.5, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10045.05}, {'date': '2023-08-12', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.52, 'volume': 10044.84}, {'date': '2023-08-13', 'open': 110.49, 'high': 120.54, 'low': 100.45, 'close': 115.51, 'volume': 10044.64}, {'date': '2023-08-14', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.44}, {'date': '2023-08-15', 'open': 110.49, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.25}, {'date': '2023-08-16', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.51, 'volume': 10044.05}, {'date': '2023-08-17', 'open': 110.48, 'high': 120.53, 'low': 100.44, 'close': 115.5, 'volume': 10043.86}, {'date': '2023-08-18', 'open': 110.48, 'high': 120.52, 'low': 100.44, 'close': 115.5, 'volume': 10043.67}, {'date': '2023-08-19', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.48}, {'date': '2023-08-20', 'open': 110.48, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.29}, {'date': '2023-08-21', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.5, 'volume': 10043.1}, {'date': '2023-08-22', 'open': 110.47, 'high': 120.52, 'low': 100.43, 'close': 115.49, 'volume': 10042.92}, {'date': '2023-08-23', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.74}, {'date': '2023-08-24', 'open': 110.47, 'high': 120.51, 'low': 100.43, 'close': 115.49, 'volume': 10042.55}, {'date': '2023-08-25', 'open': 110.47, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.37}, {'date': '2023-08-26', 'open': 110.46, 'high': 120.51, 'low': 100.42, 'close': 115.49, 'volume': 10042.19}, {'date': '2023-08-27', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10042.02}, {'date': '2023-08-28', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.84}, {'date': '2023-08-29', 'open': 110.46, 'high': 120.5, 'low': 100.42, 'close': 115.48, 'volume': 10041.67}, {'date': '2023-08-30', 'open': 110.46, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.49}, {'date': '2023-08-31', 'open': 110.45, 'high': 120.5, 'low': 100.41, 'close': 115.48, 'volume': 10041.32}, {'date': '2023-09-01', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10041.15}, {'date': '2023-09-02', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.98}, {'date': '2023-09-03', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.82}, {'date': '2023-09-04', 'open': 110.45, 'high': 120.49, 'low': 100.41, 'close': 115.47, 'volume': 10040.65}, {'date': '2023-09-05', 'open': 110.45, 'high': 120.49, 'low': 100.4, 'close': 115.47, 'volume': 10040.49}, {'date': '2023-09-06', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.32}, {'date': '2023-09-07', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.16}, {'date': '2023-09-08', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10040.0}, {'date': '2023-09-09', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.84}, {'date': '2023-09-10', 'open': 110.44, 'high': 120.48, 'low': 100.4, 'close': 115.46, 'volume': 10039.68}, {'date': '2023-09-11', 'open': 110.43, 'high': 120.47, 'low': 100.4, 'close': 115.45, 'volume': 10039.53}, {'date': '2023-09-12', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.37}, {'date': '2023-09-13', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.22}, {'date': '2023-09-14', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10039.06}, {'date': '2023-09-15', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.91}, {'date': '2023-09-16', 'open': 110.43, 'high': 120.47, 'low': 100.39, 'close': 115.45, 'volume': 10038.76}, {'date': '2023-09-17', 'open': 110.42, 'high': 120.46, 'low': 100.39, 'close': 115.44, 'volume': 10038.61}, {'date': '2023-09-18', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.46}, {'date': '2023-09-19', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.31}, {'date': '2023-09-20', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.17}, {'date': '2023-09-21', 'open': 110.42, 'high': 120.46, 'low': 100.38, 'close': 115.44, 'volume': 10038.02}, {'date': '2023-09-22', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.44, 'volume': 10037.88}, {'date': '2023-09-23', 'open': 110.42, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.74}, {'date': '2023-09-24', 'open': 110.41, 'high': 120.45, 'low': 100.38, 'close': 115.43, 'volume': 10037.59}, {'date': '2023-09-25', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.45}, {'date': '2023-09-26', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.31}, {'date': '2023-09-27', 'open': 110.41, 'high': 120.45, 'low': 100.37, 'close': 115.43, 'volume': 10037.17}, {'date': '2023-09-28', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.43, 'volume': 10037.04}, {'date': '2023-09-29', 'open': 110.41, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.9}, {'date': '2023-09-30', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.76}, {'date': '2023-10-01', 'open': 110.4, 'high': 120.44, 'low': 100.37, 'close': 115.42, 'volume': 10036.63}, {'date': '2023-10-02', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.5}, {'date': '2023-10-03', 'open': 110.4, 'high': 120.44, 'low': 100.36, 'close': 115.42, 'volume': 10036.36}, {'date': '2023-10-04', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.23}, {'date': '2023-10-05', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.42, 'volume': 10036.1}, {'date': '2023-10-06', 'open': 110.4, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.97}, {'date': '2023-10-07', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.84}, {'date': '2023-10-08', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.71}, {'date': '2023-10-09', 'open': 110.39, 'high': 120.43, 'low': 100.36, 'close': 115.41, 'volume': 10035.59}, {'date': '2023-10-10', 'open': 110.39, 'high': 120.43, 'low': 100.35, 'close': 115.41, 'volume': 10035.46}, {'date': '2023-10-11', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.41, 'volume': 10035.34}, {'date': '2023-10-12', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.21}, {'date': '2023-10-13', 'open': 110.39, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10035.09}, {'date': '2023-10-14', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.97}, {'date': '2023-10-15', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.84}, {'date': '2023-10-16', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.72}, {'date': '2023-10-17', 'open': 110.38, 'high': 120.42, 'low': 100.35, 'close': 115.4, 'volume': 10034.6}, {'date': '2023-10-18', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.48}, {'date': '2023-10-19', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.4, 'volume': 10034.36}, {'date': '2023-10-20', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.25}, {'date': '2023-10-21', 'open': 110.38, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.13}, {'date': '2023-10-22', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10034.01}, {'date': '2023-10-23', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.9}, {'date': '2023-10-24', 'open': 110.37, 'high': 120.41, 'low': 100.34, 'close': 115.39, 'volume': 10033.78}, {'date': '2023-10-25', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.67}, {'date': '2023-10-26', 'open': 110.37, 'high': 120.4, 'low': 100.34, 'close': 115.39, 'volume': 10033.56}, {'date': '2023-10-27', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.44}, {'date': '2023-10-28', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.33}, {'date': '2023-10-29', 'open': 110.37, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.22}, {'date': '2023-10-30', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.11}, {'date': '2023-10-31', 'open': 110.36, 'high': 120.4, 'low': 100.33, 'close': 115.38, 'volume': 10033.0}, {'date': '2023-11-01', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.89}, {'date': '2023-11-02', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.79}, {'date': '2023-11-03', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.38, 'volume': 10032.68}, {'date': '2023-11-04', 'open': 110.36, 'high': 120.39, 'low': 100.33, 'close': 115.37, 'volume': 10032.57}, {'date': '2023-11-05', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.47}, {'date': '2023-11-06', 'open': 110.36, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.36}, {'date': '2023-11-07', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.26}, {'date': '2023-11-08', 'open': 110.35, 'high': 120.39, 'low': 100.32, 'close': 115.37, 'volume': 10032.15}, {'date': '2023-11-09', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10032.05}, {'date': '2023-11-10', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.95}, {'date': '2023-11-11', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.85}, {'date': '2023-11-12', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.37, 'volume': 10031.75}, {'date': '2023-11-13', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.65}, {'date': '2023-11-14', 'open': 110.35, 'high': 120.38, 'low': 100.32, 'close': 115.36, 'volume': 10031.55}, {'date': '2023-11-15', 'open': 110.35, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.45}, {'date': '2023-11-16', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.35}, {'date': '2023-11-17', 'open': 110.34, 'high': 120.38, 'low': 100.31, 'close': 115.36, 'volume': 10031.25}, {'date': '2023-11-18', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.15}, {'date': '2023-11-19', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10031.06}, {'date': '2023-11-20', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.36, 'volume': 10030.96}, {'date': '2023-11-21', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.86}, {'date': '2023-11-22', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.77}, {'date': '2023-11-23', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.67}, {'date': '2023-11-24', 'open': 110.34, 'high': 120.37, 'low': 100.31, 'close': 115.35, 'volume': 10030.58}, {'date': '2023-11-25', 'open': 110.34, 'high': 120.37, 'low': 100.3, 'close': 115.35, 'volume': 10030.49}, {'date': '2023-11-26', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.4}, {'date': '2023-11-27', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.3}, {'date': '2023-11-28', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.21}, {'date': '2023-11-29', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.12}, {'date': '2023-11-30', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.35, 'volume': 10030.03}, {'date': '2023-12-01', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.94}, {'date': '2023-12-02', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.85}, {'date': '2023-12-03', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.76}, {'date': '2023-12-04', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.67}, {'date': '2023-12-05', 'open': 110.33, 'high': 120.36, 'low': 100.3, 'close': 115.34, 'volume': 10029.59}, {'date': '2023-12-06', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.5}, {'date': '2023-12-07', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.41}, {'date': '2023-12-08', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.33}, {'date': '2023-12-09', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.24}, {'date': '2023-12-10', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.34, 'volume': 10029.15}, {'date': '2023-12-11', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10029.07}, {'date': '2023-12-12', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.99}, {'date': '2023-12-13', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.9}, {'date': '2023-12-14', 'open': 110.32, 'high': 120.35, 'low': 100.29, 'close': 115.33, 'volume': 10028.82}, {'date': '2023-12-15', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.74}, {'date': '2023-12-16', 'open': 110.32, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.65}, {'date': '2023-12-17', 'open': 110.31, 'high': 120.34, 'low': 100.29, 'close': 115.33, 'volume': 10028.57}, {'date': '2023-12-18', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.49}, {'date': '2023-12-19', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.41}, {'date': '2023-12-20', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.33, 'volume': 10028.33}, {'date': '2023-12-21', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.25}, {'date': '2023-12-22', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.17}, {'date': '2023-12-23', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.09}, {'date': '2023-12-24', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10028.01}, {'date': '2023-12-25', 'open': 110.31, 'high': 120.34, 'low': 100.28, 'close': 115.32, 'volume': 10027.93}, {'date': '2023-12-26', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.86}, {'date': '2023-12-27', 'open': 110.31, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.78}, {'date': '2023-12-28', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.7}, {'date': '2023-12-29', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.62}, {'date': '2023-12-30', 'open': 110.3, 'high': 120.33, 'low': 100.28, 'close': 115.32, 'volume': 10027.55}, {'date': '2023-12-31', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.47}, {'date': '2024-01-01', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.32, 'volume': 10027.4}, {'date': '2024-01-02', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.32}, {'date': '2024-01-03', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.25}, {'date': '2024-01-04', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.17}, {'date': '2024-01-05', 'open': 110.3, 'high': 120.33, 'low': 100.27, 'close': 115.31, 'volume': 10027.1}, {'date': '2024-01-06', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10027.03}, {'date': '2024-01-07', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.95}, {'date': '2024-01-08', 'open': 110.3, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.88}, {'date': '2024-01-09', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.81}, {'date': '2024-01-10', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.74}, {'date': '2024-01-11', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.67}, {'date': '2024-01-12', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.6}, {'date': '2024-01-13', 'open': 110.29, 'high': 120.32, 'low': 100.27, 'close': 115.31, 'volume': 10026.53}, {'date': '2024-01-14', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.46}, {'date': '2024-01-15', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.39}, {'date': '2024-01-16', 'open': 110.29, 'high': 120.32, 'low': 100.26, 'close': 115.3, 'volume': 10026.32}, {'date': '2024-01-17', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.25}, {'date': '2024-01-18', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.18}, {'date': '2024-01-19', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.11}, {'date': '2024-01-20', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10026.04}, {'date': '2024-01-21', 'open': 110.29, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.97}, {'date': '2024-01-22', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.91}, {'date': '2024-01-23', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.84}, {'date': '2024-01-24', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.77}, {'date': '2024-01-25', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.3, 'volume': 10025.71}, {'date': '2024-01-26', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.64}, {'date': '2024-01-27', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.58}, {'date': '2024-01-28', 'open': 110.28, 'high': 120.31, 'low': 100.26, 'close': 115.29, 'volume': 10025.51}, {'date': '2024-01-29', 'open': 110.28, 'high': 120.31, 'low': 100.25, 'close': 115.29, 'volume': 10025.45}, {'date': '2024-01-30', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.38}, {'date': '2024-01-31', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.32}, {'date': '2024-02-01', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.25}, {'date': '2024-02-02', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.19}, {'date': '2024-02-03', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.13}, {'date': '2024-02-04', 'open': 110.28, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.06}, {'date': '2024-02-05', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10025.0}, {'date': '2024-02-06', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.94}, {'date': '2024-02-07', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.88}, {'date': '2024-02-08', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.29, 'volume': 10024.81}, {'date': '2024-02-09', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.75}, {'date': '2024-02-10', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.69}, {'date': '2024-02-11', 'open': 110.27, 'high': 120.3, 'low': 100.25, 'close': 115.28, 'volume': 10024.63}, {'date': '2024-02-12', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.57}, {'date': '2024-02-13', 'open': 110.27, 'high': 120.29, 'low': 100.25, 'close': 115.28, 'volume': 10024.51}, {'date': '2024-02-14', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.45}, {'date': '2024-02-15', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.39}, {'date': '2024-02-16', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.33}, {'date': '2024-02-17', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.27}, {'date': '2024-02-18', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.21}, {'date': '2024-02-19', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.15}, {'date': '2024-02-20', 'open': 110.27, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.1}, {'date': '2024-02-21', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10024.04}, {'date': '2024-02-22', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.98}, {'date': '2024-02-23', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.28, 'volume': 10023.92}, {'date': '2024-02-24', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.87}, {'date': '2024-02-25', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.81}, {'date': '2024-02-26', 'open': 110.26, 'high': 120.29, 'low': 100.24, 'close': 115.27, 'volume': 10023.75}, {'date': '2024-02-27', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.7}, {'date': '2024-02-28', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.64}, {'date': '2024-02-29', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.58}, {'date': '2024-03-01', 'open': 110.26, 'high': 120.28, 'low': 100.24, 'close': 115.27, 'volume': 10023.53}, {'date': '2024-03-02', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.47}, {'date': '2024-03-03', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.42}, {'date': '2024-03-04', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.36}, {'date': '2024-03-05', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.31}, {'date': '2024-03-06', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.26}, {'date': '2024-03-07', 'open': 110.26, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.2}, {'date': '2024-03-08', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.15}, {'date': '2024-03-09', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.27, 'volume': 10023.09}, {'date': '2024-03-10', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10023.04}, {'date': '2024-03-11', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.99}, {'date': '2024-03-12', 'open': 110.25, 'high': 120.28, 'low': 100.23, 'close': 115.26, 'volume': 10022.94}, {'date': '2024-03-13', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.88}, {'date': '2024-03-14', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.83}, {'date': '2024-03-15', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.78}, {'date': '2024-03-16', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.73}, {'date': '2024-03-17', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.68}, {'date': '2024-03-18', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.62}, {'date': '2024-03-19', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.57}, {'date': '2024-03-20', 'open': 110.25, 'high': 120.27, 'low': 100.23, 'close': 115.26, 'volume': 10022.52}, {'date': '2024-03-21', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.47}, {'date': '2024-03-22', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.42}, {'date': '2024-03-23', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.37}, {'date': '2024-03-24', 'open': 110.25, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.32}, {'date': '2024-03-25', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.27}, {'date': '2024-03-26', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.26, 'volume': 10022.22}, {'date': '2024-03-27', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.17}, {'date': '2024-03-28', 'open': 110.24, 'high': 120.27, 'low': 100.22, 'close': 115.25, 'volume': 10022.12}, {'date': '2024-03-29', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.08}, {'date': '2024-03-30', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10022.03}, {'date': '2024-03-31', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.98}, {'date': '2024-04-01', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.93}, {'date': '2024-04-02', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.88}, {'date': '2024-04-03', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.83}, {'date': '2024-04-04', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.79}, {'date': '2024-04-05', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.74}, {'date': '2024-04-06', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.69}, {'date': '2024-04-07', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.65}, {'date': '2024-04-08', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.6}, {'date': '2024-04-09', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.55}, {'date': '2024-04-10', 'open': 110.24, 'high': 120.26, 'low': 100.22, 'close': 115.25, 'volume': 10021.51}, {'date': '2024-04-11', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.46}, {'date': '2024-04-12', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.41}, {'date': '2024-04-13', 'open': 110.24, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.37}, {'date': '2024-04-14', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.25, 'volume': 10021.32}, {'date': '2024-04-15', 'open': 110.23, 'high': 120.26, 'low': 100.21, 'close': 115.24, 'volume': 10021.28}, {'date': '2024-04-16', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.23}, {'date': '2024-04-17', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.19}, {'date': '2024-04-18', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.14}, {'date': '2024-04-19', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.1}, {'date': '2024-04-20', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.05}, {'date': '2024-04-21', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10021.01}, {'date': '2024-04-22', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.96}, {'date': '2024-04-23', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.92}, {'date': '2024-04-24', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.88}, {'date': '2024-04-25', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.83}, {'date': '2024-04-26', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.79}, {'date': '2024-04-27', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.75}, {'date': '2024-04-28', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.7}, {'date': '2024-04-29', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.66}, {'date': '2024-04-30', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.62}, {'date': '2024-05-01', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.58}, {'date': '2024-05-02', 'open': 110.23, 'high': 120.25, 'low': 100.21, 'close': 115.24, 'volume': 10020.53}, {'date': '2024-05-03', 'open': 110.23, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.49}, {'date': '2024-05-04', 'open': 110.22, 'high': 120.25, 'low': 100.2, 'close': 115.24, 'volume': 10020.45}, {'date': '2024-05-05', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.41}, {'date': '2024-05-06', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.37}, {'date': '2024-05-07', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.33}, {'date': '2024-05-08', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.28}, {'date': '2024-05-09', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.24}, {'date': '2024-05-10', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.2}, {'date': '2024-05-11', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.16}, {'date': '2024-05-12', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.12}, {'date': '2024-05-13', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.08}, {'date': '2024-05-14', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.04}, {'date': '2024-05-15', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10020.0}, {'date': '2024-05-16', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.96}, {'date': '2024-05-17', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.92}, {'date': '2024-05-18', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.88}, {'date': '2024-05-19', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.84}, {'date': '2024-05-20', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.8}, {'date': '2024-05-21', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.76}, {'date': '2024-05-22', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.72}, {'date': '2024-05-23', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.69}, {'date': '2024-05-24', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.65}, {'date': '2024-05-25', 'open': 110.22, 'high': 120.24, 'low': 100.2, 'close': 115.23, 'volume': 10019.61}, {'date': '2024-05-26', 'open': 110.22, 'high': 120.23, 'low': 100.2, 'close': 115.23, 'volume': 10019.57}, {'date': '2024-05-27', 'open': 110.21, 'high': 120.23, 'low': 100.2, 'close': 115.22, 'volume': 10019.53}, {'date': '2024-05-28', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.49}, {'date': '2024-05-29', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.46}, {'date': '2024-05-30', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.42}, {'date': '2024-05-31', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.38}, {'date': '2024-06-01', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.34}, {'date': '2024-06-02', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.31}, {'date': '2024-06-03', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.27}, {'date': '2024-06-04', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.23}, {'date': '2024-06-05', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.19}, {'date': '2024-06-06', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.16}, {'date': '2024-06-07', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.12}, {'date': '2024-06-08', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.08}, {'date': '2024-06-09', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.05}, {'date': '2024-06-10', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10019.01}, {'date': '2024-06-11', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.98}, {'date': '2024-06-12', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.94}, {'date': '2024-06-13', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.9}, {'date': '2024-06-14', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.87}, {'date': '2024-06-15', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.83}, {'date': '2024-06-16', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.8}, {'date': '2024-06-17', 'open': 110.21, 'high': 120.23, 'low': 100.19, 'close': 115.22, 'volume': 10018.76}, {'date': '2024-06-18', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.22, 'volume': 10018.73}, {'date': '2024-06-19', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.69}, {'date': '2024-06-20', 'open': 110.21, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.66}, {'date': '2024-06-21', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.62}, {'date': '2024-06-22', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.59}, {'date': '2024-06-23', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.55}, {'date': '2024-06-24', 'open': 110.2, 'high': 120.22, 'low': 100.19, 'close': 115.21, 'volume': 10018.52}, {'date': '2024-06-25', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.48}, {'date': '2024-06-26', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.45}, {'date': '2024-06-27', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.42}, {'date': '2024-06-28', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.38}, {'date': '2024-06-29', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.35}, {'date': '2024-06-30', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.32}, {'date': '2024-07-01', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.28}, {'date': '2024-07-02', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.25}, {'date': '2024-07-03', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.21}, {'date': '2024-07-04', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.18}, {'date': '2024-07-05', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.15}, {'date': '2024-07-06', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.12}, {'date': '2024-07-07', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.08}, {'date': '2024-07-08', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.05}, {'date': '2024-07-09', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10018.02}, {'date': '2024-07-10', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.99}, {'date': '2024-07-11', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.95}, {'date': '2024-07-12', 'open': 110.2, 'high': 120.22, 'low': 100.18, 'close': 115.21, 'volume': 10017.92}, {'date': '2024-07-13', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.89}, {'date': '2024-07-14', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.21, 'volume': 10017.86}, {'date': '2024-07-15', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.83}, {'date': '2024-07-16', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.79}, {'date': '2024-07-17', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.76}, {'date': '2024-07-18', 'open': 110.2, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.73}, {'date': '2024-07-19', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.7}, {'date': '2024-07-20', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.67}, {'date': '2024-07-21', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.64}, {'date': '2024-07-22', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.61}, {'date': '2024-07-23', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.57}, {'date': '2024-07-24', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.54}, {'date': '2024-07-25', 'open': 110.19, 'high': 120.21, 'low': 100.18, 'close': 115.2, 'volume': 10017.51}, {'date': '2024-07-26', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.48}, {'date': '2024-07-27', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.45}, {'date': '2024-07-28', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.42}, {'date': '2024-07-29', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.39}, {'date': '2024-07-30', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.36}, {'date': '2024-07-31', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.33}, {'date': '2024-08-01', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.3}, {'date': '2024-08-02', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.27}, {'date': '2024-08-03', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.24}, {'date': '2024-08-04', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.21}, {'date': '2024-08-05', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.18}, {'date': '2024-08-06', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.15}, {'date': '2024-08-07', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.12}, {'date': '2024-08-08', 'open': 110.19, 'high': 120.21, 'low': 100.17, 'close': 115.2, 'volume': 10017.09}, {'date': '2024-08-09', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.06}, {'date': '2024-08-10', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.04}, {'date': '2024-08-11', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10017.01}, {'date': '2024-08-12', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.2, 'volume': 10016.98}, {'date': '2024-08-13', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.95}, {'date': '2024-08-14', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.92}, {'date': '2024-08-15', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.89}, {'date': '2024-08-16', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.86}, {'date': '2024-08-17', 'open': 110.19, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.84}, {'date': '2024-08-18', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.81}, {'date': '2024-08-19', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.78}, {'date': '2024-08-20', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.75}, {'date': '2024-08-21', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.72}, {'date': '2024-08-22', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.69}, {'date': '2024-08-23', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.67}, {'date': '2024-08-24', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.64}, {'date': '2024-08-25', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.61}, {'date': '2024-08-26', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.58}, {'date': '2024-08-27', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.56}, {'date': '2024-08-28', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.53}, {'date': '2024-08-29', 'open': 110.18, 'high': 120.2, 'low': 100.17, 'close': 115.19, 'volume': 10016.5}, {'date': '2024-08-30', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.47}, {'date': '2024-08-31', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.45}, {'date': '2024-09-01', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.42}, {'date': '2024-09-02', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.39}, {'date': '2024-09-03', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.37}, {'date': '2024-09-04', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.34}, {'date': '2024-09-05', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.31}, {'date': '2024-09-06', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.29}, {'date': '2024-09-07', 'open': 110.18, 'high': 120.2, 'low': 100.16, 'close': 115.19, 'volume': 10016.26}, {'date': '2024-09-08', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.23}, {'date': '2024-09-09', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.21}, {'date': '2024-09-10', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.18}, {'date': '2024-09-11', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.16}, {'date': '2024-09-12', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.13}, {'date': '2024-09-13', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.19, 'volume': 10016.1}, {'date': '2024-09-14', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.08}, {'date': '2024-09-15', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.05}, {'date': '2024-09-16', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.03}, {'date': '2024-09-17', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10016.0}, {'date': '2024-09-18', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.97}, {'date': '2024-09-19', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.95}, {'date': '2024-09-20', 'open': 110.18, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.92}, {'date': '2024-09-21', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.9}, {'date': '2024-09-22', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.87}, {'date': '2024-09-23', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.85}, {'date': '2024-09-24', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.82}, {'date': '2024-09-25', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.8}, {'date': '2024-09-26', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.77}, {'date': '2024-09-27', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.75}, {'date': '2024-09-28', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.72}, {'date': '2024-09-29', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.7}, {'date': '2024-09-30', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.67}, {'date': '2024-10-01', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.65}, {'date': '2024-10-02', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.62}, {'date': '2024-10-03', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.6}, {'date': '2024-10-04', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.58}, {'date': '2024-10-05', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.55}, {'date': '2024-10-06', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.53}, {'date': '2024-10-07', 'open': 110.17, 'high': 120.19, 'low': 100.16, 'close': 115.18, 'volume': 10015.5}, {'date': '2024-10-08', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.48}, {'date': '2024-10-09', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.46}, {'date': '2024-10-10', 'open': 110.17, 'high': 120.19, 'low': 100.15, 'close': 115.18, 'volume': 10015.43}, {'date': '2024-10-11', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.41}, {'date': '2024-10-12', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.38}, {'date': '2024-10-13', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.36}, {'date': '2024-10-14', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.34}, {'date': '2024-10-15', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.31}, {'date': '2024-10-16', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.29}, {'date': '2024-10-17', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.27}, {'date': '2024-10-18', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.24}, {'date': '2024-10-19', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.18, 'volume': 10015.22}, {'date': '2024-10-20', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.2}, {'date': '2024-10-21', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.17}, {'date': '2024-10-22', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.15}, {'date': '2024-10-23', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.13}, {'date': '2024-10-24', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.11}, {'date': '2024-10-25', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.08}, {'date': '2024-10-26', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.06}, {'date': '2024-10-27', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.04}, {'date': '2024-10-28', 'open': 110.17, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10015.02}, {'date': '2024-10-29', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.99}, {'date': '2024-10-30', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.97}, {'date': '2024-10-31', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.95}, {'date': '2024-11-01', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.93}, {'date': '2024-11-02', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.9}, {'date': '2024-11-03', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.88}, {'date': '2024-11-04', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.86}, {'date': '2024-11-05', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.84}, {'date': '2024-11-06', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.81}, {'date': '2024-11-07', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.79}, {'date': '2024-11-08', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.77}, {'date': '2024-11-09', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.75}, {'date': '2024-11-10', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.73}, {'date': '2024-11-11', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.71}, {'date': '2024-11-12', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.68}, {'date': '2024-11-13', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.66}, {'date': '2024-11-14', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.64}, {'date': '2024-11-15', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.62}, {'date': '2024-11-16', 'open': 110.16, 'high': 120.18, 'low': 100.15, 'close': 115.17, 'volume': 10014.6}, {'date': '2024-11-17', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.58}, {'date': '2024-11-18', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.56}, {'date': '2024-11-19', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.53}, {'date': '2024-11-20', 'open': 110.16, 'high': 120.17, 'low': 100.15, 'close': 115.17, 'volume': 10014.51}, {'date': '2024-11-21', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.49}, {'date': '2024-11-22', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.47}, {'date': '2024-11-23', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.45}, {'date': '2024-11-24', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.43}, {'date': '2024-11-25', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.41}, {'date': '2024-11-26', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.39}, {'date': '2024-11-27', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.17, 'volume': 10014.37}, {'date': '2024-11-28', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.35}, {'date': '2024-11-29', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.33}, {'date': '2024-11-30', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.31}, {'date': '2024-12-01', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.29}, {'date': '2024-12-02', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.27}, {'date': '2024-12-03', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.25}, {'date': '2024-12-04', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.22}, {'date': '2024-12-05', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.2}, {'date': '2024-12-06', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.18}, {'date': '2024-12-07', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.16}, {'date': '2024-12-08', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.14}, {'date': '2024-12-09', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.12}, {'date': '2024-12-10', 'open': 110.16, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.1}, {'date': '2024-12-11', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.08}, {'date': '2024-12-12', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.06}, {'date': '2024-12-13', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.04}, {'date': '2024-12-14', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.03}, {'date': '2024-12-15', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10014.01}, {'date': '2024-12-16', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.99}, {'date': '2024-12-17', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.97}, {'date': '2024-12-18', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.95}, {'date': '2024-12-19', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.93}, {'date': '2024-12-20', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.91}, {'date': '2024-12-21', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.89}, {'date': '2024-12-22', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.87}, {'date': '2024-12-23', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.85}, {'date': '2024-12-24', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.83}, {'date': '2024-12-25', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.81}, {'date': '2024-12-26', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.79}, {'date': '2024-12-27', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.77}, {'date': '2024-12-28', 'open': 110.15, 'high': 120.17, 'low': 100.14, 'close': 115.16, 'volume': 10013.76}, {'date': '2024-12-29', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.74}, {'date': '2024-12-30', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.72}, {'date': '2024-12-31', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.7}, {'date': '2025-01-01', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.68}, {'date': '2025-01-02', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.66}, {'date': '2025-01-03', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.64}, {'date': '2025-01-04', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.62}, {'date': '2025-01-05', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.61}, {'date': '2025-01-06', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.59}, {'date': '2025-01-07', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.57}, {'date': '2025-01-08', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.55}, {'date': '2025-01-09', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.53}, {'date': '2025-01-10', 'open': 110.15, 'high': 120.16, 'low': 100.14, 'close': 115.16, 'volume': 10013.51}, {'date': '2025-01-11', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.16, 'volume': 10013.5}, {'date': '2025-01-12', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.48}, {'date': '2025-01-13', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.46}, {'date': '2025-01-14', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.44}, {'date': '2025-01-15', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.42}, {'date': '2025-01-16', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.4}, {'date': '2025-01-17', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.39}, {'date': '2025-01-18', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.37}, {'date': '2025-01-19', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.35}, {'date': '2025-01-20', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.33}, {'date': '2025-01-21', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.32}, {'date': '2025-01-22', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.3}, {'date': '2025-01-23', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.28}, {'date': '2025-01-24', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.26}, {'date': '2025-01-25', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.25}, {'date': '2025-01-26', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.23}, {'date': '2025-01-27', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.21}, {'date': '2025-01-28', 'open': 110.15, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.19}, {'date': '2025-01-29', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.18}, {'date': '2025-01-30', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.16}, {'date': '2025-01-31', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.14}, {'date': '2025-02-01', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.12}, {'date': '2025-02-02', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.11}, {'date': '2025-02-03', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.09}, {'date': '2025-02-04', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.07}, {'date': '2025-02-05', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.05}, {'date': '2025-02-06', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.04}, {'date': '2025-02-07', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.02}, {'date': '2025-02-08', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10013.0}, {'date': '2025-02-09', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.99}, {'date': '2025-02-10', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.97}, {'date': '2025-02-11', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.95}, {'date': '2025-02-12', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.94}, {'date': '2025-02-13', 'open': 110.14, 'high': 120.16, 'low': 100.13, 'close': 115.15, 'volume': 10012.92}, {'date': '2025-02-14', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.9}, {'date': '2025-02-15', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.89}, {'date': '2025-02-16', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.87}, {'date': '2025-02-17', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.85}, {'date': '2025-02-18', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.84}, {'date': '2025-02-19', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.82}, {'date': '2025-02-20', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.8}, {'date': '2025-02-21', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.79}, {'date': '2025-02-22', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.77}, {'date': '2025-02-23', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.76}, {'date': '2025-02-24', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.74}, {'date': '2025-02-25', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.72}, {'date': '2025-02-26', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.71}, {'date': '2025-02-27', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.69}, {'date': '2025-02-28', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.67}, {'date': '2025-03-01', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.66}, {'date': '2025-03-02', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.64}, {'date': '2025-03-03', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.63}, {'date': '2025-03-04', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.15, 'volume': 10012.61}, {'date': '2025-03-05', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.59}, {'date': '2025-03-06', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.58}, {'date': '2025-03-07', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.56}, {'date': '2025-03-08', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.55}, {'date': '2025-03-09', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.53}, {'date': '2025-03-10', 'open': 110.14, 'high': 120.15, 'low': 100.13, 'close': 115.14, 'volume': 10012.52}, {'date': '2025-03-11', 'open': 110.14, 'high': 120.15, 'low': 100.12, 'close': 115.14, 'volume': 10012.5}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Target periodic return series (index column plus the target column).", + "default": null, + "optional": false + }, + { + "name": "factors_data", + "type": "list[Data]", + "description": "Factor return matrix (index column plus one column per factor), in the same units as the target.", + "default": null, + "optional": false + }, + { + "name": "periods", + "type": "list[str]", + "description": "Named look-back periods to attribute over, anchored to the latest factor observation.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Name of the return column in `data` to attribute across the factors.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Name of the index column shared by `data` and `factors_data`.", + "default": "date", + "optional": true + }, + { + "name": "risk_free_column", + "type": "str", + "description": "Optional name of the risk-free rate column in `factors_data`. When provided, the target is converted to excess returns before attribution and the column is dropped from the factor set.", + "default": null, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ReturnAttributionData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period", + "type": "str", + "description": "Look-back period the attribution was run over.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "factor", + "type": "str", + "description": "Factor name, 'Alpha' for the intercept contribution, or 'Residual' for the unexplained residual.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "contribution", + "type": "float", + "description": "Component's contribution to the period's total target return: for a factor, beta_i * sum_t factor_i; for 'Alpha', alpha * n; for 'Residual', sum of regression residuals. The three sum to the period's total target return.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "share", + "type": "float", + "description": "Component's contribution divided by the total target return over the period. Shares sum to 1.0 unless the total return is zero.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/sec/filing_headers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download the index headers, and cover page if available, for any SEC filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.filing_headers(url='https://www.sec.gov/Archives/edgar/data/317540/000119312524076556/d645509ddef14a.htm', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "url", + "type": "str | None", + "description": "URL for the SEC filing. The specific URL is not directly used or downloaded, but is used to generate the base URL for the filing. e.g. https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/coke-20240731.htm and https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/ are both valid URLs for the same filing.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Filing URL" + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use cache for the index headers and cover page. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecFiling", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "base_url", + "type": "str", + "description": "Base URL of the filing.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "name", + "type": "str", + "description": "Name of the entity filing.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "cik", + "type": "str", + "description": "Central Index Key.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "trading_symbols", + "type": "list | None", + "description": "Trading symbols, if available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "sic", + "type": "str", + "description": "Standard Industrial Classification.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "sic_organization_name", + "type": "str", + "description": "SIC Organization Name.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "filing_date", + "type": "date", + "description": "Filing date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "period_ending", + "type": "date | None", + "description": "Date of the ending period for the filing, if available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "fiscal_year_end", + "type": "str | None", + "description": "Fiscal year end of the entity, if available. Format: MM-DD", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "document_type", + "type": "str", + "description": "Specific SEC filing type.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "has_cover_page", + "type": "bool", + "description": "True if the filing has a cover page.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "description", + "type": "str | None", + "description": "Description of attached content, mostly applicable to 8-K filings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "cover_page", + "type": "dict | None", + "description": "Cover page information, if available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "document_urls", + "type": "list", + "description": "List of files associated with the filing.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + } + ] + }, + "model": "SecFiling", + "openapi_extra": { + "widget_config": { + "description": "Get a list of all the documents associated with a filing, and their direct URLs.", + "gridData": { + "w": 30, + "h": 10 + }, + "refetchInterval": false, + "data": { + "dataKey": "results.document_urls" + } + }, + "model": "SecFiling" + } + }, + "/sec/full_text_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the full text of all SEC EDGAR filings since 2001.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.full_text_search(query='climate change', provider='sec')\nobb.sec.full_text_search(entity='AAPL', form_type='10-K', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "query", + "type": "str | None", + "description": "Words or phrases to find in filing documents. Use quotes for an exact phrase, OR / NOT (or -) for boolean logic, and * for a trailing wildcard.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "entity", + "type": "str | None", + "description": "Company name, ticker, CIK number, or individual's name.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Filing category to filter by - a preset group of form types.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Filing Category", + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/fts_categories", + "style": { + "popupWidth": 700 + } + } + } + }, + { + "name": "form_type", + "type": "str | None | list[str | None]", + "description": "Specific form type(s) to filter by, comma-separated. Prefix a form type with a hyphen to exclude it - e.g., -4 excludes Form 4. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Form Type", + "type": "text", + "multiSelect": true, + "optionsEndpoint": "/api/v1/sec/fts_form_types" + } + } + }, + { + "name": "location", + "type": "str | None", + "description": "Location code of the principal executive offices to filter by.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Located In", + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/fts_locations", + "style": { + "popupWidth": 400 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. The earliest available date is 2001-01-01.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecFullTextSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "filing_date", + "type": "date | None", + "description": "Date the filing was submitted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "form", + "type": "str | None", + "description": "The SEC form type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the filer(s).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Ticker symbol(s) of the filer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key(s) of the filer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Filing or document description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "URL of the matched document on SEC EDGAR.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecFullTextSearch", + "openapi_extra": { + "widget_config": { + "name": "Full-Text Search", + "description": "Search the full text of all EDGAR filings since 2001. Click a row's Document cell to load that filing in the Index Headers and Filing Viewer widgets.", + "type": "table", + "runButton": true, + "refetchInterval": false, + "gridData": { + "w": 20, + "h": 14 + }, + "data": { + "dataKey": "results", + "table": { + "showAll": true, + "enableAdvanced": true, + "columnsDefs": [ + { + "field": "url", + "headerName": "Document", + "headerTooltip": "Click to load this filing in the Index Headers and Filing Viewer widgets.", + "pinned": "left", + "cellDataType": "text", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "url" + } + } + }, + { + "field": "filing_date", + "headerName": "Filing Date", + "cellDataType": "date" + }, + { + "field": "form", + "headerName": "Form", + "cellDataType": "text" + }, + { + "field": "name", + "headerName": "Company", + "cellDataType": "text" + }, + { + "field": "symbol", + "headerName": "Symbol", + "cellDataType": "text" + }, + { + "field": "cik", + "headerName": "CIK", + "cellDataType": "text" + }, + { + "field": "description", + "headerName": "Description", + "cellDataType": "text" + } + ] + } + } + }, + "model": "SecFullTextSearch" + } + }, + "/sec/htm_file": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download a raw HTML object from the SEC website.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.htm_file(url='https://www.sec.gov/Archives/edgar/data/1723690/000119312525030074/d866336dex991.htm', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "url", + "type": "str | None", + "description": "URL for the SEC filing.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Cache the file for use later. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecHtmFile", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "url", + "type": "str", + "description": "URL of the downloaded file.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + }, + { + "name": "content", + "type": "str", + "description": "Raw content of the HTM/HTML file.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecHtmFile", + "openapi_extra": { + "widget_config": { + "name": "Open HTML", + "description": "Open a HTM/HTML document from the SEC website.", + "gridData": { + "w": 40, + "h": 25 + }, + "refetchInterval": false, + "type": "markdown", + "data": { + "dataKey": "results.content" + } + }, + "model": "SecHtmFile" + } + }, + "/sec/cik_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Map a ticker symbol to a CIK number.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.cik_map(symbol='MSFT', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache for the request, default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CikMap", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "cik", + "type": "int | str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [] + }, + "model": "CikMap", + "openapi_extra": { + "model": "CikMap" + } + }, + "/sec/institutions_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.institutions_search(provider='sec')\nobb.sec.institutions_search(query='blackstone real estate', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "InstitutionsSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "name", + "type": "str | None", + "description": "The name of the institution.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "int | str | None", + "description": "Central Index Key (CIK)", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "InstitutionsSearch", + "openapi_extra": { + "model": "InstitutionsSearch" + } + }, + "/sec/adviser_firms": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search SEC investment adviser firms.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.adviser_firms(query='blackrock', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Firm or individual name or CRD number to search for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of matching firms or individuals to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cached SEC responses.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecAdviserFirms", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "crd", + "type": "str", + "description": "Central Registration Depository (CRD) number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sec_number", + "type": "str | None", + "description": "SEC investment adviser number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Investment adviser firm name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str | None", + "description": "Investment adviser registration status.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "branch_count", + "type": "int | None", + "description": "Number of branches associated with the firm.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "address_line_1", + "type": "str | None", + "description": "First line of the firm's office address.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "address_line_2", + "type": "str | None", + "description": "Second line of the firm's office address.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "city", + "type": "str | None", + "description": "Office city.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "Office state or region.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "postal_code", + "type": "str | None", + "description": "Office postal code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Office country.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecAdviserFirms", + "openapi_extra": { + "model": "SecAdviserFirms" + } + }, + "/sec/adviser_individuals": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search SEC adviser individuals, with one row per current employer.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.adviser_individuals(query='john smith', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Firm or individual name or CRD number to search for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of matching firms or individuals to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cached SEC responses.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecAdviserIndividuals", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "crd", + "type": "str", + "description": "Central Registration Depository (CRD) number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "first_name", + "type": "str", + "description": "First name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "middle_name", + "type": "str | None", + "description": "Middle name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_name", + "type": "str", + "description": "Last name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "suffix", + "type": "str | None", + "description": "Name suffix.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str", + "description": "Investment adviser registration status.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "broker_dealer_status", + "type": "str | None", + "description": "Broker-dealer registration status.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_start_date", + "type": "date | None", + "description": "Date the individual entered the securities industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_days", + "type": "int | None", + "description": "Number of securities-industry days reported by IAPD.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employment_count", + "type": "int | None", + "description": "Number of employments reported by IAPD.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finra_registration_count", + "type": "int | None", + "description": "Number of approved FINRA registrations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_firm_crd", + "type": "str | None", + "description": "CRD number of a current employer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_firm_name", + "type": "str | None", + "description": "Name of a current employer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_firm_ia_sec_number", + "type": "str | None", + "description": "Investment adviser SEC number of the current employer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_firm_bd_sec_number", + "type": "str | None", + "description": "Broker-dealer SEC number of the current employer.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecAdviserIndividuals", + "openapi_extra": { + "model": "SecAdviserIndividuals" + } + }, + "/sec/adviser_documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List available Form ADV and brochure documents by firm CRD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.adviser_documents(crd='148826', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "crd", + "type": "str", + "description": "Central Registration Depository (CRD) number.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cached SEC responses.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecAdviserDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "crd", + "type": "str", + "description": "Central Registration Depository (CRD) number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "firm_name", + "type": "str", + "description": "Investment adviser firm name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "document_type", + "type": "str", + "description": "Regulatory document type.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "document_id", + "type": "str | None", + "description": "Document identifier reported by IAPD.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | None", + "description": "Date the document was filed or submitted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "Public adviserinfo.sec.gov document URL.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecAdviserDocuments", + "openapi_extra": { + "model": "SecAdviserDocuments" + } + }, + "/sec/adviser_universe": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get current registered or exempt Form ADV Part 1 data, optionally by CRD.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.adviser_universe(registration_type='registered', provider='sec')\nobb.sec.adviser_universe(registration_type='exempt', provider='sec')\nobb.sec.adviser_universe(registration_type='registered', crd='148826', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "registration_type", + "type": "str", + "description": "Registered or exempt adviser population to return.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "crd", + "type": "str | None", + "description": "Central Registration Depository (CRD) number to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cached SEC responses.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecAdviserUniverse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "crd", + "type": "str", + "description": "Central Registration Depository (CRD) number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sec_number", + "type": "str", + "description": "SEC investment adviser number.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "First reported CIK, zero-padded to 10 digits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik_count", + "type": "int | None", + "description": "Total number of CIKs reported by the firm.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_business_name", + "type": "str", + "description": "Primary business name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "legal_name", + "type": "str", + "description": "Legal name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "firm_type", + "type": "str", + "description": "Registration category reported in the SEC data file.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "status", + "type": "str", + "description": "Current SEC registration status.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "latest_adv_filing_date", + "type": "date", + "description": "Date of the latest Form ADV filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "employee_count", + "type": "int | None", + "description": "Number of employees reported in Form ADV Item 5.A.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "discretionary_aum", + "type": "float | int | None", + "description": "Discretionary regulatory assets under management.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_discretionary_aum", + "type": "float | int | None", + "description": "Non-discretionary regulatory assets under management.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "regulatory_assets_under_management", + "type": "float | int | None", + "description": "Total regulatory assets under management.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "discretionary_account_count", + "type": "int | None", + "description": "Number of discretionary accounts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_discretionary_account_count", + "type": "int | None", + "description": "Number of non-discretionary accounts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "account_count", + "type": "int | None", + "description": "Total number of accounts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_date", + "type": "date", + "description": "Report month, represented by its first calendar day.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecAdviserUniverse", + "openapi_extra": { + "model": "SecAdviserUniverse" + } + }, + "/sec/schema_files": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Explore SEC and FASB XBRL taxonomy schemas, labels, and presentation structures.\n\n- No parameters: list all available taxonomy families.\n- taxonomy only: get all parsed structures for the most recent year.\n- taxonomy + year: get all parsed structures for a specific year.\n- taxonomy + component: get one component's structure using the most recent year.\n- taxonomy + year + component: get one component's parsed structure.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.schema_files(provider='sec')\n# Explore XBRL taxonomies progressively.\n# List all available taxonomy families\nobb.sec.schema_files(provider='sec')\n# List components for US GAAP (latest year)\nobb.sec.schema_files(taxonomy='us-gaap', provider='sec')\n# List presentation components for US GAAP 2024\nobb.sec.schema_files(taxonomy='us-gaap', year=2024, provider='sec')\n# Get the Statement of Income presentation structure\nobb.sec.schema_files(taxonomy='us-gaap', year=2024, component='soi', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "taxonomy", + "type": "str | None", + "description": "Taxonomy family to explore. Omit to list all available taxonomies and their descriptions.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int | None", + "description": "Taxonomy year (e.g. 2011+ for us-gaap, varies by taxonomy). Defaults to the most recent year when omitted.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "component", + "type": "str | None", + "description": "Presentation component to retrieve. Values are taxonomy-specific. Omit to return all components for the taxonomy.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Filter taxonomies by SEC filer category.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SchemaFiles", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "name", + "type": "str", + "description": "Identifier: taxonomy key, year, component name, or XBRL element ID depending on the query mode.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "Human-readable label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description or long name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Taxonomy category (e.g., operating_company).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style", + "type": "str | None", + "description": "Taxonomy style (e.g., FASB_STANDARD, SEC_EMBEDDED).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "has_label_linkbase", + "type": "bool | None", + "description": "Whether the taxonomy has a parseable label linkbase.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "URL to the taxonomy resource or SEC reference page.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "level", + "type": "int | None", + "description": "Hierarchy depth in presentation structure (0 = root).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "float | None", + "description": "Sort order within parent in presentation structure.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_id", + "type": "str | None", + "description": "Parent XBRL element ID in presentation structure.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_label", + "type": "str | None", + "description": "Preferred label role URI for presentation rendering.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xbrl_type", + "type": "str | None", + "description": "XBRL data type (e.g., monetaryItemType, textBlockItemType, stringItemType, sharesItemType, perShareItemType, domainItemType).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_type", + "type": "str | None", + "description": "Period type: 'instant' (point-in-time) or 'duration' (over a period).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance_type", + "type": "str | None", + "description": "Balance type for monetary items: 'credit' or 'debit'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "abstract", + "type": "bool | None", + "description": "Whether the element is abstract (grouping/heading only, not taggable).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "substitution_group", + "type": "str | None", + "description": "XBRL substitution group: 'item' (line item), 'dimensionItem' (axis), 'hypercubeItem' (table).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nillable", + "type": "bool | None", + "description": "Whether the element value can be nil.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SchemaFiles", + "openapi_extra": { + "model": "SchemaFiles" + } + }, + "/sec/symbol_map": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.symbol_map(query='0000789019', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "Search query.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SymbolMap", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SymbolMap", + "openapi_extra": { + "model": "SymbolMap" + } + }, + "/sec/rss_litigation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.rss_litigation(provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "limit", + "type": "int | None", + "description": "Number of litigation releases to return, newest first.", + "default": 25, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "RssLitigation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "title", + "type": "str", + "description": "The title of the litigation release.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "datetime | str", + "description": "The date of publication.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "author", + "type": "str | None", + "description": "The author of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "excerpt", + "type": "str | None", + "description": "Short summary of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "body", + "type": "str | None", + "description": "Full text of the litigation release, when retrievable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "URL to the litigation release.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "id", + "type": "str | None", + "description": "The litigation release identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "RssLitigation", + "openapi_extra": { + "model": "RssLitigation" + } + }, + "/sec/sic_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.sic_search(provider='sec')\nobb.sec.sic_search(query='real estate investment trusts', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "query", + "type": "str", + "description": "Search query to match against SIC code, industry title, or office.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SicSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "sic", + "type": "int", + "description": "Sector Industrial Code (SIC)", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "industry", + "type": "str", + "description": "Industry title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "office", + "type": "str", + "description": "Reporting office within the Corporate Finance Office", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SicSearch", + "openapi_extra": { + "model": "SicSearch" + } + }, + "/sec/financial_statements": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the financial statements exactly as reported in a company's latest 10-K/10-Q filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.financial_statements(symbol='AAPL', provider='sec')\nobb.sec.financial_statements(symbol='AAPL', statement_type='balance', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "statement_type", + "type": "str | None", + "description": "The financial statement to retrieve, as reported in the filing.", + "default": "income", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K/10-Q filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar quarter (Q1-Q4) of the filing; leave empty for the most recent annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecAsFiledStatements", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "order", + "type": "int | None", + "description": "Presentation order of the line item.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tag", + "type": "str | None", + "description": "XBRL concept tag, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_tag", + "type": "str | None", + "description": "Parent concept tag or section.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_label", + "type": "str | None", + "description": "Preferred label role.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance", + "type": "str | None", + "description": "Balance type (credit/debit).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | str | None", + "description": "Calculation weight.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "decimals", + "type": "int | str | None", + "description": "Reported decimals.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "context_ref", + "type": "str | None", + "description": "XBRL context reference or period descriptor.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_beginning", + "type": "str | None", + "description": "Start of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "str | None", + "description": "End of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of measure.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "label", + "type": "str | None", + "description": "Line item label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | str | None", + "description": "Reported value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecAsFiledStatements", + "openapi_extra": { + "model": "SecAsFiledStatements" + } + }, + "/sec/company_overview": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the company overview - entity profile and Business (Item 1) section - from a filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.company_overview(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the 10-K. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecCompanyOverview", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "content", + "type": "str", + "description": "The Business section (Item 1) of the 10-K as formatted markdown.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecCompanyOverview", + "openapi_extra": { + "model": "SecCompanyOverview" + } + }, + "/sec/executive_compensation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Summary Compensation Table from a company's proxy statement (DEF 14A).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.executive_compensation(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year the proxy was filed. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecExecutiveCompensation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "content", + "type": "str", + "description": "The Summary Compensation Table from the proxy (DEF 14A) as a formatted markdown table.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecExecutiveCompensation", + "openapi_extra": { + "model": "SecExecutiveCompensation" + } + }, + "/sec/beneficial_ownership": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the 5%+ beneficial owners table from a company's proxy statement (DEF 14A).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.beneficial_ownership(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year the proxy was filed. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecBeneficialOwnership", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "content", + "type": "str", + "description": "The 5%+ beneficial owners table from the proxy (DEF 14A) as a formatted markdown table.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecBeneficialOwnership", + "openapi_extra": { + "model": "SecBeneficialOwnership" + } + }, + "/sec/management_profiles": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get management profiles from annual filings and referenced proxy statements.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.management_profiles(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecManagementProfiles", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "content", + "type": "str", + "description": "Management profiles and governance information as formatted markdown.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecManagementProfiles", + "openapi_extra": { + "model": "SecManagementProfiles" + } + }, + "/sec/pay_versus_performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Pay Versus Performance disclosure (Item 402(v)) XBRL facts from a proxy.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.pay_versus_performance(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year the proxy was filed. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecPayVersusPerformance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "year", + "type": "int", + "description": "Fiscal year.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "peo_total_compensation", + "type": "float | None", + "description": "Principal executive officer total compensation (Summary Compensation Table total).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "peo_compensation_actually_paid", + "type": "float | None", + "description": "Principal executive officer compensation actually paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_neo_total_compensation", + "type": "float | None", + "description": "Average total compensation of the non-PEO named executive officers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_neo_compensation_actually_paid", + "type": "float | None", + "description": "Average compensation actually paid to the non-PEO named executive officers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_shareholder_return", + "type": "float | None", + "description": "Cumulative total shareholder return on a $100 investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "peer_group_total_shareholder_return", + "type": "float | None", + "description": "Peer-group cumulative total shareholder return on a $100 investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "float | None", + "description": "Net income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_selected_measure", + "type": "float | None", + "description": "The company-selected financial performance measure value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_selected_measure_name", + "type": "str | None", + "description": "Name of the company-selected financial performance measure.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecPayVersusPerformance", + "openapi_extra": { + "model": "SecPayVersusPerformance" + } + }, + "/sec/disclosures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the disclosure text blocks and tables - notes to the financial statements - from a filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.disclosures(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K/10-Q filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar quarter (Q1-Q4) of the filing; leave empty for the most recent annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecDisclosures", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "key", + "type": "str", + "description": "Disclosure identifier.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Disclosure name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "text", + "type": "str | None", + "description": "Disclosure text content, with tables as markdown.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tables", + "type": "list | None", + "description": "Structured tables extracted from the disclosure.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecDisclosures", + "openapi_extra": { + "model": "SecDisclosures" + } + }, + "/sec/risk_factors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Risk Factors (Item 1A) section from a company's latest 10-K/10-Q filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.risk_factors(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K/10-Q filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar quarter (Q1-Q4) of the filing; leave empty for the most recent annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecRiskFactors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "risk_factor", + "type": "str | None", + "description": "The individual risk factor heading.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "text", + "type": "str", + "description": "The text of the risk factor.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecRiskFactors", + "openapi_extra": { + "model": "SecRiskFactors" + } + }, + "/sec/segment_revenue": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the segment and geographic breakdown of revenues from a filing's XBRL data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.segment_revenue(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K/10-Q filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar quarter (Q1-Q4) of the filing; leave empty for the most recent annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecSegmentRevenue", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "name", + "type": "str", + "description": "Disclosure name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "text", + "type": "str | None", + "description": "Disclosure text, with the segment/revenue tables as markdown.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecSegmentRevenue", + "openapi_extra": { + "model": "SecSegmentRevenue" + } + }, + "/sec/legal_proceedings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Legal Proceedings section (Item 3 / Part II Item 1) from a filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.legal_proceedings(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K/10-Q filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar quarter (Q1-Q4) of the filing; leave empty for the most recent annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecLegalProceedings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "name", + "type": "str", + "description": "Section name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "item_num", + "type": "str | None", + "description": "Filing item number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "text", + "type": "str", + "description": "Legal Proceedings section text.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecLegalProceedings", + "openapi_extra": { + "model": "SecLegalProceedings" + } + }, + "/sec/exhibit": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a single attached exhibit document from a filing, rendered as markdown.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.exhibit(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "exhibit", + "type": "str | None", + "description": "Exhibit identifier (e.g. EX-21). Defaults to the first exhibit attached to the filing.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "Direct URL to a 10-K/10-Q filing, e.g. from `latest_financial_reports`. When provided, the filing is parsed directly and the other params are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the filing. Defaults to the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar quarter (Q1-Q4) of the filing; leave empty for the most recent annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Use the cache for downloaded filings. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecExhibit", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "content", + "type": "str", + "description": "The exhibit content rendered as markdown.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecExhibit", + "openapi_extra": { + "model": "SecExhibit" + } + }, + "/sec/balance_sheet": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the balance sheet for a given company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.balance_sheet(symbol='AAPL', provider='sec')\nobb.sec.balance_sheet(symbol='AAPL', period='annual', limit=5, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return. For balance sheet, TTM is treated as the average of the last 4 quarters.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache (4-hour memory) for the SEC request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_preliminary", + "type": "bool | None", + "description": "Whether to include preliminary data from 8-K filings for periods not yet reported on 10-Q/K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pit_mode", + "type": "bool | None", + "description": "Point-in-time mode. When True, returns data as originally reported at the time of filing, without subsequent restatements or amendments. For annual data, uses the original 10-K values. For quarterly data, preserves 10-Q filing vintage instead of using restated comparatives from the 10-K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecBalanceSheet", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "reported_currency", + "type": "str | None", + "description": "The currency in which the balance sheet is reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_and_equivalents", + "type": "float | None", + "description": "Amount of cash and cash equivalent. Cash includes, but is not limited to, currency on hand, demand deposit with financial institution, and account with general characteristic of demand deposit. Cash equivalent includes, but is not limited to, short-term, highly liquid investment that is both readily convertible to known amount of cash and so near maturity that it presents insignificant risk of change in value because of change in interest rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restricted_cash", + "type": "float | None", + "description": "Amount of cash restricted as to withdrawal or usage. Cash includes, but is not limited to, currency on hand, demand deposits with banks or financial institutions, and other accounts with general characteristics of demand deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_investments", + "type": "float | None", + "description": "Amount of investment in marketable security, classified as current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fed_funds_sold", + "type": "float | None", + "description": "Includes: (1) the amount outstanding of funds lent to other depository institutions, securities brokers, or securities dealers in the form of Federal Funds sold; for example, immediately available funds lent under agreements or contracts that mature in one business day or roll over under a continuing contract, regardless of the nature of the transaction or the collateral involved, excluding overnight lending for commercial and industrial purposes. Also include Federal Funds sold under agreements to resell on a gross basis, excluding (1) sales of term Federal Funds, (2) due bills representing purchases of securities or other assets by the reporting bank that have not yet been delivered and similar instruments, (3) resale agreements that mature in more than one business day involving assets other than securities, and (4) yield maintenance dollar repurchase agreements (Federal Funds Sold) and (2) the dollar amount outstanding of funds lent in the form of security resale agreements regardless of maturity, if the agreement requires the bank to resell the identical security purchased or a security that meets the definition of substantially the same in the case of a dollar roll. Also include purchases of participations in pools of securities, regardless of maturity (Securities Purchased Under Agreements to Re-sell).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_bearing_deposits_at_other_banks", + "type": "float | None", + "description": "For banks and other depository institutions (including Federal Reserve Banks, if applicable): Interest-bearing deposits in other financial institutions for relatively short periods of time including, for example, certificates of deposits, which are presented separately from cash on the balance sheet.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "time_deposits_placed", + "type": "float | None", + "description": "Amount of time deposit liabilities, including certificates of deposit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trading_account_securities", + "type": "float | None", + "description": "Amount of investment in debt security measured at fair value with change in fair value recognized in net income (trading) and investment in equity security measured at fair value with change in fair value recognized in net income (FV-NI).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loans_and_leases", + "type": "float | None", + "description": "Amortized cost excluding accrued interest, before allowance for credit loss, of financing receivable. Excludes net investment in lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "allowance_for_loan_and_lease_losses", + "type": "float | None", + "description": "Amount of allowance for credit loss on financing receivable. Excludes allowance for financing receivable covered under loss sharing agreement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_loans_and_leases", + "type": "float | None", + "description": "Amortized cost excluding accrued interest, after allowance for credit loss, of financing receivable. Excludes net investment in lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loans_held_for_sale", + "type": "float | None", + "description": "Amount before allowance and after deduction of deferred interest and fees, unamortized costs and premiums and discounts from face amounts, of loans and leases held in portfolio, including but not limited to, commercial and consumer loans. Excludes loans and leases covered under loss sharing agreements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_investment_income", + "type": "float | None", + "description": "Interest, dividends, rents, ancillary and other revenues earned but not yet received by the entity on its investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accounts_receivable", + "type": "float | None", + "description": "Amount, after allowance for credit loss, of right to consideration from customer for product sold and service rendered in normal course of business, classified as current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customer_and_other_receivables", + "type": "float | None", + "description": "Amount, after allowance for credit loss, of right to consideration from customer for product sold and service rendered in normal course of business.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "note_receivable", + "type": "float | None", + "description": "Amortized cost, after allowance for credit loss, of financing receivable classified as current. Excludes net investment in lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nontrade_receivables", + "type": "float | None", + "description": "The sum of amounts currently receivable other than from customers. For classified balance sheets, represents the current amount receivable, that is amounts expected to be collected within one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_inventory", + "type": "float | None", + "description": "Amount after valuation and LIFO reserves of inventory expected to be sold, or consumed within one year or operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prepaid_expenses", + "type": "float | None", + "description": "Amount of asset related to consideration paid in advance for costs that provide economic benefits within a future period of one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_tax_assets", + "type": "float | None", + "description": "The current portion of the aggregate tax effects as of the balance sheet date of all future tax deductions arising from temporary differences between tax basis and generally accepted accounting principles basis recognition of assets, liabilities, revenues and expenses, which can only be deducted for tax purposes when permitted under enacted tax laws; after deducting the allocated valuation allowance, if any, to reduce such amount to net realizable value. Deferred tax liabilities and assets are classified as current or noncurrent based on the classification of the related asset or liability for financial reporting. A deferred tax liability or asset that is not related to an asset or liability for financial reporting, including deferred tax assets related to carryforwards, are classified according to the expected reversal date of the temporary difference. An unrecognized tax benefit that is directly related to a position taken in a tax year that results in a net operating loss carryforward is presented as a reduction of the related deferred tax asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_assets", + "type": "float | None", + "description": "Amount of current assets classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_nonoperating_assets", + "type": "float | None", + "description": "Amount of asset related to consideration paid in advance for costs that provide economic benefits in future periods, and amount of other assets that are expected to be realized or consumed within one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_current_assets", + "type": "float | None", + "description": "Amount of asset recognized for present right to economic benefit, classified as current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_ppe", + "type": "float | None", + "description": "Amount, before accumulated depreciation, depletion, and amortization, of property, plant, and equipment. Includes, but is not limited to, land and land improvement; building; machinery and equipment; furniture and fixture; and work of art, historical treasure, or similar asset classified as collection.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accumulated_depreciation", + "type": "float | None", + "description": "Amount of accumulated depreciation, depletion, and amortization of property, plant, and equipment. Includes, but is not limited to, land and land improvement; building; machinery and equipment; furniture and fixture; and work of art, historical treasure, or similar asset classified as collection.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_ppe", + "type": "float | None", + "description": "Amount, after accumulated depreciation, depletion, and amortization, of property, plant, and equipment. Includes, but is not limited to, land and land improvement; building; machinery and equipment; furniture and fixture; and work of art, historical treasure, or similar asset classified as collection.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_premises_and_equipment", + "type": "float | None", + "description": "Amount, after accumulated depreciation, depletion, and amortization, of property, plant, and equipment. Includes, but is not limited to, land and land improvement; building; machinery and equipment; furniture and fixture; and work of art, historical treasure, or similar asset classified as collection.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_lease_right_of_use_asset", + "type": "float | None", + "description": "Amount of lessee's right to use underlying asset under operating lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finance_lease_right_of_use_asset", + "type": "float | None", + "description": "Amount, after accumulated amortization, of right-of-use asset from finance lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_investments", + "type": "float | None", + "description": "Amount of investment in marketable security, classified as noncurrent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mortgage_servicing_rights", + "type": "float | None", + "description": "Fair value of an asset representing net future revenue from contractually specified servicing fees, late charges, and other ancillary revenues, in excess of future costs related to servicing arrangements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_acquisition_cost", + "type": "float | None", + "description": "Amount of deferred policy acquisition cost capitalized on contract remaining in force.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "separate_account_business_assets", + "type": "float | None", + "description": "Amount of asset at fair value held for benefit of separate account policyholder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncurrent_note_receivables", + "type": "float | None", + "description": "Amount, after allowance for credit loss, of financing receivable, classified as noncurrent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goodwill", + "type": "float | None", + "description": "Amount, after accumulated impairment loss, of asset representing future economic benefit arising from other asset acquired in business combination or from joint venture formation or both, that is not individually identified and separately recognized.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "intangible_assets", + "type": "float | None", + "description": "Amount, after accumulated amortization, of finite- and indefinite-lived intangible assets and capitalized cost for software to be sold, leased, or marketed. Excludes goodwill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncurrent_deferred_tax_assets", + "type": "float | None", + "description": "The noncurrent portion as of the balance sheet date of the aggregate carrying amount of all future tax deductions arising from temporary differences between tax basis and generally accepted accounting principles basis recognition of assets, liabilities, revenues and expenses, which can only be deducted for tax purposes when permitted under enacted tax laws; after the valuation allowance, if any, to reduce such amount to net realizable value. Deferred tax liabilities and assets are classified as current or noncurrent based on the classification of the related asset or liability for financial reporting. A deferred tax liability or asset that is not related to an asset or liability for financial reporting, including deferred tax assets related to carryforwards, is classified according to the expected reversal date of the temporary difference.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employee_benefit_assets", + "type": "float | None", + "description": "This represents the entire assets recognized in the balance sheet that are associated with the defined benefit plans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_noncurrent_assets", + "type": "float | None", + "description": "Amount of noncurrent assets classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_noncurrent_nonoperating_assets", + "type": "float | None", + "description": "Amount of investments, and noncurrent assets classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_noncurrent_assets_excl_ppe", + "type": "float | None", + "description": "Noncurrent assets other than investments and PP&E.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_noncurrent_assets", + "type": "float | None", + "description": "Sum of the carrying amounts as of the balance sheet date of all assets that are expected to be realized in cash, sold or consumed after one year or beyond the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_assets", + "type": "float | None", + "description": "Amount of assets classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "float | None", + "description": "Amount of asset recognized for present right to economic benefit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noninterest_bearing_deposits", + "type": "float | None", + "description": "The aggregate amount of all domestic and foreign noninterest-bearing deposits liabilities held by the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_bearing_deposits", + "type": "float | None", + "description": "The aggregate of all domestic and foreign interest-bearing deposit liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fed_funds_purchased", + "type": "float | None", + "description": "Amount after offset of short term borrowing where a bank borrows, at the federal funds rate, from another bank and securities that an entity sells and agrees to repurchase at a specified date for a specified price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_debt", + "type": "float | None", + "description": "Reflects the total carrying amount as of the balance sheet date of debt having initial terms less than one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_portion_of_long_term_debt", + "type": "float | None", + "description": "Amount of long-term debt due within one year or within the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bankers_acceptances", + "type": "float | None", + "description": "Amount of short-term, negotiable time drafts drawn on and accepted by a financial institution. Bankers acceptances are a bank's promise to pay to the holder of the draft a stated amount on a specified date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accounts_payable", + "type": "float | None", + "description": "Carrying value as of the balance sheet date of liabilities incurred (and for which invoices have typically been received) and payable to vendors for goods and services received that are used in an entity's business. Used to reflect the current portion of the liabilities (due within one year or within the normal operating cycle if longer).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_interest_payable", + "type": "float | None", + "description": "Carrying value as of the balance sheet date of [accrued] interest payable on all forms of debt, including trade payables, that has been incurred and is unpaid. Used to reflect the current portion of the liabilities (due within one year or within the normal operating cycle if longer).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_short_term_payables", + "type": "float | None", + "description": "Amount of borrowings classified as other, maturing within one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_expenses", + "type": "float | None", + "description": "Carrying value as of the balance sheet date of obligations incurred and payable, pertaining to costs that are statutory in nature, are incurred on contractual obligations, or accumulate over time and for which invoices have not yet been received or will not be rendered. Examples include taxes, interest, rent and utilities. Used to reflect the current portion of the liabilities (due within one year or within the normal operating cycle if longer).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customer_deposits", + "type": "float | None", + "description": "Carrying amount of liabilities for customer deposits received and held, classified as current. Includes cash received in advance for undelivered goods or services and refundable security deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividends_payable", + "type": "float | None", + "description": "Carrying value as of the balance sheet date of dividends declared but unpaid on equity securities issued by the entity and outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_revenue", + "type": "float | None", + "description": "Amount of deferred income and obligation to transfer product and service to customer for which consideration has been received or is receivable, classified as current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_tax_liabilities", + "type": "float | None", + "description": "Represents the current portion of deferred tax liabilities, which result from applying the applicable tax rate to net taxable temporary differences pertaining to each jurisdiction to which the entity is obligated to pay income tax. A current taxable temporary difference is a difference between the tax basis and the carrying amount of a current asset or liability in the financial statements prepared in accordance with generally accepted accounting principles. In a classified statement of financial position, an enterprise separates deferred tax liabilities and assets into a current amount and a noncurrent amount. Deferred tax liabilities and assets are classified as current or noncurrent based on the classification of the related asset or liability for financial reporting. A deferred tax liability or asset that is not related to an asset or liability for financial reporting, including deferred tax assets related to carryforwards, is classified according to the expected reversal date of the temporary difference.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_employee_benefit_liabilities", + "type": "float | None", + "description": "Total of the carrying values as of the balance sheet date of obligations incurred through that date and payable for obligations related to services received from employees, such as accrued salaries and bonuses, payroll taxes and fringe benefits. Used to reflect the current portion of the liabilities (due within one year or within the normal operating cycle if longer).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_taxes_payable", + "type": "float | None", + "description": "Carrying value as of the balance sheet date of obligations incurred and payable for statutory income, sales, use, payroll, excise, real, property and other taxes. Used to reflect the current portion of the liabilities (due within one year or within the normal operating cycle if longer).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_liabilities", + "type": "float | None", + "description": "Amount of liabilities classified as other, due within one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_nonoperating_liabilities", + "type": "float | None", + "description": "Amount of current liabilities from nonoperating activities, classified as other. Includes accrued liabilities and other liabilities not separately disclosed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_lease_liability_current", + "type": "float | None", + "description": "Present value of lessee's discounted obligation for lease payments from operating lease, classified as current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finance_lease_liability_current", + "type": "float | None", + "description": "Present value of lessee's discounted obligation for lease payments from finance lease, classified as current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_current_liabilities", + "type": "float | None", + "description": "Total obligations incurred as part of normal operations that are expected to be paid during the following twelve months or within one business cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt", + "type": "float | None", + "description": "Amount, after deduction of unamortized premium (discount) and debt issuance cost, of long-term debt classified as noncurrent. Excludes lease obligation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_lease_obligations", + "type": "float | None", + "description": "Present value of lessee's discounted obligation for lease payments from finance lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_lease_liability_noncurrent", + "type": "float | None", + "description": "Present value of lessee's discounted obligation for lease payments from operating lease, classified as noncurrent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "claims_and_claim_expenses", + "type": "float | None", + "description": "The amount needed to reflect the estimated ultimate cost of settling claims relating to insured events that have occurred on or before the balance sheet date, whether or not reported to the insurer at that date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "future_policy_benefits", + "type": "float | None", + "description": "Amount, before effect of reinsurance, of present value of future benefit to be paid to or on behalf of policyholder and related expense less present value of future net premium receivable under insurance contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unearned_premiums_credit", + "type": "float | None", + "description": "Carrying amount of premiums written on insurance contracts that have not been earned as of the balance sheet date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "policyholder_funds", + "type": "float | None", + "description": "Amount due to policyholders for funds held that are returnable under the terms of insurance contracts, classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "participating_policyholder_equity", + "type": "float | None", + "description": "Amount due to policyholders for funds held that are returnable under the terms of insurance contracts, classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "separate_account_business_liabilities", + "type": "float | None", + "description": "Amount of liability for variable contract in which all or portion of contract holder's funds is allocated to specific separate account and supported by assets held in separate account.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_long_term_liabilities", + "type": "float | None", + "description": "Amount of liabilities classified as other, due after one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_retirement_and_litigation_obligation", + "type": "float | None", + "description": "Noncurrent portion of the carrying amount of a liability for an asset retirement obligation. An asset retirement obligation is a legal obligation associated with the disposal or retirement of a tangible long-lived asset that results from the acquisition, construction or development, or the normal operations of a long-lived asset, except for certain obligations of lessees.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncurrent_deferred_revenue", + "type": "float | None", + "description": "Amount of deferred income and obligation to transfer product and service to customer for which consideration has been received or is receivable, classified as noncurrent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncurrent_deferred_tax_liabilities", + "type": "float | None", + "description": "Amount, after deferred tax asset, of deferred tax liability attributable to taxable differences with jurisdictional netting.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncurrent_employee_benefit_liabilities", + "type": "float | None", + "description": "Amount of liability, recognized in statement of financial position, for defined benefit pension and other postretirement plans, classified as noncurrent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_noncurrent_liabilities", + "type": "float | None", + "description": "Amount of liabilities classified as other, due after one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_noncurrent_nonoperating_liabilities", + "type": "float | None", + "description": "Amount of noncurrent liabilities from nonoperating activities, classified as other. Includes deferred income taxes and other liabilities not separately disclosed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_noncurrent_liabilities", + "type": "float | None", + "description": "Amount of obligation due after one year or beyond the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_liabilities", + "type": "float | None", + "description": "Amount of liability recognized for present obligation requiring transfer or otherwise providing economic benefit to others.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commitments_and_contingencies", + "type": "float | None", + "description": "Represents the caption on the face of the balance sheet to indicate that the entity has entered into (1) purchase or supply arrangements that will require expending a portion of its resources to meet the terms thereof, and (2) is exposed to potential losses or, less frequently, gains, arising from (a) possible claims against a company's resources due to future performance under contract terms, and (b) possible losses or likely gains from uncertainties that will ultimately be resolved when one or more future events that are deemed likely to occur do occur or fail to occur.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "temporary_equity", + "type": "float | None", + "description": "Carrying amount of the equity component of securities that are redeemable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "temporary_equity_parent", + "type": "float | None", + "description": "Carrying amount of temporary equity attributable to parent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "redeemable_noncontrolling_interest", + "type": "float | None", + "description": "As of the reporting date, the aggregate carrying amount of all noncontrolling interests which are redeemable by the (parent) entity (1) at a fixed or determinable price on a fixed or determinable date, (2) at the option of the holder of the noncontrolling interest, or (3) upon occurrence of an event that is not solely within the control of the (parent) entity. This item includes noncontrolling interest holder's ownership (or holders' ownership) regardless of the type of equity interest (common, preferred, other) including all potential organizational (legal) forms of the investee entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "redeemable_nci_common", + "type": "float | None", + "description": "Equity carrying amount of the common stock component of redeemable NCI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "redeemable_nci_preferred", + "type": "float | None", + "description": "Equity carrying amount of the preferred stock component of redeemable NCI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "redeemable_nci_other", + "type": "float | None", + "description": "Equity carrying amount of the other component of redeemable NCI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_preferred_equity", + "type": "float | None", + "description": "Aggregate par or stated value of issued nonredeemable preferred stock (or preferred stock redeemable solely at the option of the issuer). This item includes treasury stock repurchased by the entity. Note: elements for number of nonredeemable preferred shares, par value and other disclosure concepts are in another section within stockholders' equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_equity", + "type": "float | None", + "description": "Aggregate par or stated value of issued nonredeemable common stock (or common stock redeemable solely at the option of the issuer). This item includes treasury stock repurchased by the entity. Note: elements for number of nonredeemable common shares, par value and other disclosure concepts are in another section within stockholders' equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "additional_paid_in_capital", + "type": "float | None", + "description": "Value received from shareholders in common stock-related transactions that are in excess of par value or stated value and amounts received from other stock-related transactions. Includes only common stock transactions (excludes preferred stock transactions). May be called contributed capital, capital in excess of par, capital surplus, or paid-in capital.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "retained_earnings", + "type": "float | None", + "description": "Amount of accumulated undistributed earnings (deficit).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "treasury_stock", + "type": "float | None", + "description": "The amount allocated to treasury stock. Treasury stock is common and preferred shares of an entity that were issued, repurchased by the entity, and are held in its treasury.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accumulated_other_comprehensive_income", + "type": "float | None", + "description": "Amount, after tax, of accumulated increase (decrease) in equity from transaction and other event and circumstance from nonowner source.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_equity", + "type": "float | None", + "description": "This element represents movements included in the statement of changes in stockholders' equity which are not separately disclosed or provided for elsewhere in the taxonomy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_common_equity", + "type": "float | None", + "description": "Amount of equity (deficit) attributable to parent. Excludes temporary equity and equity attributable to noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_equity", + "type": "float | None", + "description": "Amount of equity (deficit) attributable to parent. Excludes temporary equity and equity attributable to noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncontrolling_interests", + "type": "float | None", + "description": "Amount of equity (deficit) attributable to noncontrolling interest. Excludes temporary equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_equity_and_noncontrolling_interests", + "type": "float | None", + "description": "Amount of equity (deficit) attributable to parent and noncontrolling interest. Excludes temporary equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_liabilities_and_equity", + "type": "float | None", + "description": "Amount of liabilities and equity items, including the portion of equity attributable to noncontrolling interests, if any.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecBalanceSheet", + "openapi_extra": { + "model": "SecBalanceSheet" + } + }, + "/sec/balance_sheet_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's balance sheet items over time.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.balance_sheet_growth(symbol='AAPL', provider='sec')\nobb.sec.balance_sheet_growth(symbol='AAPL', limit=10, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return. For balance sheet growth, 'quarterly_yoy' compares the most recent quarter to the same quarter in the prior year, and TTM compares the most recent quarter to the average of the same quarter and the three preceding quarters in the prior year.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache (4-hour memory) for the SEC request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_preliminary", + "type": "bool | None", + "description": "Whether to include preliminary data from 8-K filings for periods not yet reported on 10-Q/K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pit_mode", + "type": "bool | None", + "description": "Point-in-time mode. When True, returns data as originally reported at the time of filing, without subsequent restatements or amendments. For annual data, uses the original 10-K values. For quarterly data, preserves 10-Q filing vintage instead of using restated comparatives from the 10-K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecBalanceSheetGrowth", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "growth_cash_and_equivalents", + "type": "float | None", + "description": "Growth rate of cash and cash equivalents.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_restricted_cash", + "type": "float | None", + "description": "Growth rate of restricted cash.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_short_term_investments", + "type": "float | None", + "description": "Growth rate of short-term investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_fed_funds_sold", + "type": "float | None", + "description": "Growth rate of federal funds sold.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_interest_bearing_deposits_at_other_banks", + "type": "float | None", + "description": "Growth rate of interest-bearing deposits at other banks.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_time_deposits_placed", + "type": "float | None", + "description": "Growth rate of time deposits placed.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_trading_account_securities", + "type": "float | None", + "description": "Growth rate of trading account securities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_loans_and_leases", + "type": "float | None", + "description": "Growth rate of loans and leases.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_allowance_for_loan_and_lease_losses", + "type": "float | None", + "description": "Growth rate of allowance for loan and lease losses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_loans_and_leases", + "type": "float | None", + "description": "Growth rate of net loans and leases.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_loans_held_for_sale", + "type": "float | None", + "description": "Growth rate of loans held for sale.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accrued_investment_income", + "type": "float | None", + "description": "Growth rate of accrued investment income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accounts_receivable", + "type": "float | None", + "description": "Growth rate of accounts receivable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_customer_and_other_receivables", + "type": "float | None", + "description": "Growth rate of customer and other receivables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_note_receivable", + "type": "float | None", + "description": "Growth rate of note receivable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_nontrade_receivables", + "type": "float | None", + "description": "Growth rate of nontrade receivables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_inventory", + "type": "float | None", + "description": "Growth rate of net inventory.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_prepaid_expenses", + "type": "float | None", + "description": "Growth rate of prepaid expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_current_deferred_tax_assets", + "type": "float | None", + "description": "Growth rate of current deferred tax assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_current_assets", + "type": "float | None", + "description": "Growth rate of other current assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_current_nonoperating_assets", + "type": "float | None", + "description": "Growth rate of other current nonoperating assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_current_assets", + "type": "float | None", + "description": "Growth rate of total current assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_gross_ppe", + "type": "float | None", + "description": "Growth rate of gross property, plant, and equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accumulated_depreciation", + "type": "float | None", + "description": "Growth rate of accumulated depreciation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_ppe", + "type": "float | None", + "description": "Growth rate of net property, plant, and equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_premises_and_equipment", + "type": "float | None", + "description": "Growth rate of net premises and equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_operating_lease_right_of_use_asset", + "type": "float | None", + "description": "Growth rate of operating lease right-of-use asset.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_finance_lease_right_of_use_asset", + "type": "float | None", + "description": "Growth rate of finance lease right-of-use asset.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_long_term_investments", + "type": "float | None", + "description": "Growth rate of long-term investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_mortgage_servicing_rights", + "type": "float | None", + "description": "Growth rate of mortgage servicing rights.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_deferred_acquisition_cost", + "type": "float | None", + "description": "Growth rate of deferred acquisition cost.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_separate_account_business_assets", + "type": "float | None", + "description": "Growth rate of separate account business assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncurrent_note_receivables", + "type": "float | None", + "description": "Growth rate of noncurrent note receivables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_goodwill", + "type": "float | None", + "description": "Growth rate of goodwill.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_intangible_assets", + "type": "float | None", + "description": "Growth rate of intangible assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncurrent_deferred_tax_assets", + "type": "float | None", + "description": "Growth rate of noncurrent deferred tax assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_employee_benefit_assets", + "type": "float | None", + "description": "Growth rate of employee benefit assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_noncurrent_assets", + "type": "float | None", + "description": "Growth rate of other noncurrent assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_noncurrent_nonoperating_assets", + "type": "float | None", + "description": "Growth rate of other noncurrent nonoperating assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_noncurrent_assets_excl_ppe", + "type": "float | None", + "description": "Growth rate of other noncurrent assets excluding PPE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_noncurrent_assets", + "type": "float | None", + "description": "Growth rate of total noncurrent assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_assets", + "type": "float | None", + "description": "Growth rate of other assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_assets", + "type": "float | None", + "description": "Growth rate of total assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noninterest_bearing_deposits", + "type": "float | None", + "description": "Growth rate of noninterest-bearing deposits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_interest_bearing_deposits", + "type": "float | None", + "description": "Growth rate of interest-bearing deposits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_fed_funds_purchased", + "type": "float | None", + "description": "Growth rate of federal funds purchased.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_short_term_debt", + "type": "float | None", + "description": "Growth rate of short-term debt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_current_portion_of_long_term_debt", + "type": "float | None", + "description": "Growth rate of current portion of long-term debt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_bankers_acceptances", + "type": "float | None", + "description": "Growth rate of bankers acceptances.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accounts_payable", + "type": "float | None", + "description": "Growth rate of accounts payable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accrued_interest_payable", + "type": "float | None", + "description": "Growth rate of accrued interest payable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_short_term_payables", + "type": "float | None", + "description": "Growth rate of other short-term payables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accrued_expenses", + "type": "float | None", + "description": "Growth rate of accrued expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_customer_deposits", + "type": "float | None", + "description": "Growth rate of customer deposits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_dividends_payable", + "type": "float | None", + "description": "Growth rate of dividends payable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_current_deferred_revenue", + "type": "float | None", + "description": "Growth rate of current deferred revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_current_deferred_tax_liabilities", + "type": "float | None", + "description": "Growth rate of current deferred tax liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_current_employee_benefit_liabilities", + "type": "float | None", + "description": "Growth rate of current employee benefit liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_taxes_payable", + "type": "float | None", + "description": "Growth rate of other taxes payable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_current_liabilities", + "type": "float | None", + "description": "Growth rate of other current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_current_nonoperating_liabilities", + "type": "float | None", + "description": "Growth rate of other current nonoperating liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_operating_lease_liability_current", + "type": "float | None", + "description": "Growth rate of current operating lease liability.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_finance_lease_liability_current", + "type": "float | None", + "description": "Growth rate of current finance lease liability.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_current_liabilities", + "type": "float | None", + "description": "Growth rate of total current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_long_term_debt", + "type": "float | None", + "description": "Growth rate of long-term debt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_capital_lease_obligations", + "type": "float | None", + "description": "Growth rate of capital lease obligations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_operating_lease_liability_noncurrent", + "type": "float | None", + "description": "Growth rate of noncurrent operating lease liability.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_claims_and_claim_expenses", + "type": "float | None", + "description": "Growth rate of claims and claim expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_future_policy_benefits", + "type": "float | None", + "description": "Growth rate of future policy benefits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_unearned_premiums_credit", + "type": "float | None", + "description": "Growth rate of unearned premiums credit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_policyholder_funds", + "type": "float | None", + "description": "Growth rate of policyholder funds.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_participating_policyholder_equity", + "type": "float | None", + "description": "Growth rate of participating policyholder equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_separate_account_business_liabilities", + "type": "float | None", + "description": "Growth rate of separate account business liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_long_term_liabilities", + "type": "float | None", + "description": "Growth rate of other long-term liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_asset_retirement_and_litigation_obligation", + "type": "float | None", + "description": "Growth rate of asset retirement and litigation obligation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncurrent_deferred_revenue", + "type": "float | None", + "description": "Growth rate of noncurrent deferred revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncurrent_deferred_tax_liabilities", + "type": "float | None", + "description": "Growth rate of noncurrent deferred tax liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncurrent_employee_benefit_liabilities", + "type": "float | None", + "description": "Growth rate of noncurrent employee benefit liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_noncurrent_liabilities", + "type": "float | None", + "description": "Growth rate of other noncurrent liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_noncurrent_nonoperating_liabilities", + "type": "float | None", + "description": "Growth rate of other noncurrent nonoperating liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_noncurrent_liabilities", + "type": "float | None", + "description": "Growth rate of total noncurrent liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_liabilities", + "type": "float | None", + "description": "Growth rate of total liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_commitments_and_contingencies", + "type": "float | None", + "description": "Growth rate of commitments and contingencies.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_temporary_equity", + "type": "float | None", + "description": "Growth rate of temporary equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_temporary_equity_parent", + "type": "float | None", + "description": "Growth rate of temporary equity attributable to parent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_redeemable_noncontrolling_interest", + "type": "float | None", + "description": "Growth rate of redeemable noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_redeemable_nci_common", + "type": "float | None", + "description": "Growth rate of redeemable NCI common.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_redeemable_nci_preferred", + "type": "float | None", + "description": "Growth rate of redeemable NCI preferred.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_redeemable_nci_other", + "type": "float | None", + "description": "Growth rate of redeemable NCI other.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_preferred_equity", + "type": "float | None", + "description": "Growth rate of total preferred equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_common_equity", + "type": "float | None", + "description": "Growth rate of common equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_additional_paid_in_capital", + "type": "float | None", + "description": "Growth rate of additional paid-in capital.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_retained_earnings", + "type": "float | None", + "description": "Growth rate of retained earnings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_treasury_stock", + "type": "float | None", + "description": "Growth rate of treasury stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_accumulated_other_comprehensive_income", + "type": "float | None", + "description": "Growth rate of accumulated other comprehensive income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_equity", + "type": "float | None", + "description": "Growth rate of other equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_common_equity", + "type": "float | None", + "description": "Growth rate of total common equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_equity", + "type": "float | None", + "description": "Growth rate of total equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncontrolling_interests", + "type": "float | None", + "description": "Growth rate of noncontrolling interests.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_equity_and_noncontrolling_interests", + "type": "float | None", + "description": "Growth rate of total equity and noncontrolling interests.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_liabilities_and_equity", + "type": "float | None", + "description": "Growth rate of total liabilities and equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "SecBalanceSheetGrowth", + "openapi_extra": { + "model": "SecBalanceSheetGrowth" + } + }, + "/sec/cash_flow": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the cash flow statement for a given company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.cash_flow(symbol='AAPL', provider='sec')\nobb.sec.cash_flow(symbol='AAPL', period='annual', limit=5, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache (4-hour memory) for the SEC request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_preliminary", + "type": "bool | None", + "description": "Whether to include preliminary data from 8-K filings for periods not yet reported on 10-Q/K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pit_mode", + "type": "bool | None", + "description": "Point-in-time mode. When True, returns data as originally reported at the time of filing, without subsequent restatements or amendments. For annual data, uses the original 10-K values. For quarterly data, preserves 10-Q filing vintage instead of using restated comparatives from the 10-K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecCashFlowStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "reported_currency", + "type": "str | None", + "description": "The currency in which the cash flow statement is reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "float | None", + "description": "The consolidated profit or loss for the period, net of income taxes, including the portion attributable to the noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_discontinued", + "type": "float | None", + "description": "Amount after tax of income (loss) from a discontinued operation including the portion attributable to the noncontrolling interest. Includes, but is not limited to, the income (loss) from operations during the phase-out period, gain (loss) on disposal, gain (loss) for reversal of write-down (write-down) to fair value, less cost to sell, and adjustments to a prior period gain (loss) on disposal.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_continuing", + "type": "float | None", + "description": "Amount after tax of income (loss) from continuing operations including portion attributable to the noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "provision_for_loan_losses", + "type": "float | None", + "description": "Amount of expense related to estimated loss from loan and lease transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_expense", + "type": "float | None", + "description": "The current period expense charged against earnings on long-lived, physical assets not used in production, and which are not intended for resale, to allocate or recognize the cost of such assets over their useful lives; or to record the reduction in book value of an intangible asset over the benefit period of such asset; or to reflect consumption during the period of an asset that is not used in production.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_expense", + "type": "float | None", + "description": "Amount of amortization expense for finite-lived intangible asset. Excludes goodwill and capitalized cost for software to be sold, leased, or marketed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_and_amortization", + "type": "float | None", + "description": "The aggregate expense recognized in the current period that allocates the cost of tangible and intangible assets over their useful lives.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_based_compensation", + "type": "float | None", + "description": "Amount of noncash expense for share-based payment arrangement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_income_tax", + "type": "float | None", + "description": "Amount of deferred income tax expense (benefit) pertaining to income (loss) from continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_loss_on_investments", + "type": "float | None", + "description": "Amount of realized and unrealized gain (loss) on investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_loss_on_sale_of_assets", + "type": "float | None", + "description": "Amount of gain (loss) on sale or disposal of property, plant and equipment assets, including oil and gas property and timber property.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_loss_from_equity_method_investments", + "type": "float | None", + "description": "Amount of income (loss) for proportionate share of equity method investee's income (loss).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_impairment_charges", + "type": "float | None", + "description": "Amount of impairment loss for asset. Includes, but is not limited to, tangible and intangible assets and goodwill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncash_adjustments_to_net_income", + "type": "float | None", + "description": "Amount of income (expense) included in net income that results in no cash inflow (outflow), classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_operating_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from operating activity, classified as other, in reconciling net income to reflect cash provided by (used in) operating activity when indirect cash flow method is applied.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_insurance_reserves", + "type": "float | None", + "description": "The increase (decrease) in health care insurance liability balances during the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_accounts_receivable", + "type": "float | None", + "description": "The increase (decrease) during the reporting period in amount due within one year (or one business cycle) from customers for the credit sale of goods and services.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_nontrade_receivables", + "type": "float | None", + "description": "Amount of increase (decrease) in receivables classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_inventories", + "type": "float | None", + "description": "The increase (decrease) during the reporting period in the aggregate value of all inventory held by the reporting entity, associated with underlying transactions that are classified as operating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_accounts_payable", + "type": "float | None", + "description": "The increase (decrease) during the reporting period in the aggregate amount of liabilities incurred (and for which invoices have typically been received) and payable to vendors for goods and services received that are used in an entity's business.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_operating_assets_and_liabilities", + "type": "float | None", + "description": "Amount of increase (decrease) in operating assets classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "increase_decrease_in_operating_capital", + "type": "float | None", + "description": "Amount of increase (decrease) in asset and (increase) decrease in liability, used in operating activity in reconciling net income to reflect cash provided by (used in) operating activity when indirect cash flow method is applied.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_continuing_operating_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from operating activity, including, but not limited to, discontinued operation. Operating activity includes, but is not limited to, transaction, adjustment, and change in value not defined as investing or financing activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_discontinued_operating_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from operating activity attributable to discontinued operation. Operating activity includes, but is not limited to, transaction, adjustment, and change in value not defined as investing or financing activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_operating_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from operating activity, including, but not limited to, discontinued operation. Operating activity includes, but is not limited to, transaction, adjustment, and change in value not defined as investing or financing activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_plant_property_and_equipment", + "type": "float | None", + "description": "The cash outflow associated with the acquisition of long-lived, physical assets that are used in the normal conduct of business to produce goods and services and not intended for resale; includes cash outflows to pay for construction of self-constructed assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acquisitions", + "type": "float | None", + "description": "The cash outflow associated with the acquisition of a business, net of the cash acquired from the purchase.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_investments", + "type": "float | None", + "description": "Amount of cash outflow to acquire investment in debt security measured at fair value with change in fair value recognized in other comprehensive income (available-for-sale).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_held_to_maturity_investments", + "type": "float | None", + "description": "Amount of cash outflow through purchase of long-term held-to-maturity securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_plant_property_and_equipment", + "type": "float | None", + "description": "The cash inflow from the sale of long-lived, physical assets that are used in the normal conduct of business to produce goods and services and not intended for resale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_productive_assets", + "type": "float | None", + "description": "The cash inflow from the sale of property, plant and equipment (capital expenditures), software, and other intangible assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "divestitures", + "type": "float | None", + "description": "The cash inflow associated with the amount received from the sale of a portion of the company's business, for example a segment, division, branch or other business, during the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_investments", + "type": "float | None", + "description": "Amount of cash inflow from sale of investment in debt security measured at fair value with change in fair value recognized in other comprehensive income (available-for-sale).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_of_investments", + "type": "float | None", + "description": "Amount of cash inflow from maturity, prepayment and call of investment in debt security measured at fair value with change in fair value recognized in other comprehensive income (available-for-sale).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_increase_in_fed_funds_sold", + "type": "float | None", + "description": "The net cash inflow or outflow from the fund lent to other financial institution arising from the excess in reserve deposited at Federal Reserve Bank to meet legal requirement. This borrowing is usually contracted on an overnight basis at an agreed rate of interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loans_held_for_sale_net", + "type": "float | None", + "description": "The net cash outflow or inflow for the increase (decrease) in the beginning and end of period of loan and lease balances which are not originated or purchased specifically for resale. Includes cash payments and proceeds associated with (a) loans held-for-investment, (b) leases held-for-investment, and (c) both.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_investing_activities_net", + "type": "float | None", + "description": "Amount of cash (inflow) outflow from investing activity, classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_continuing_investing_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from investing activity, including, but not limited to, discontinued operation. Investing activity includes, but is not limited to, making and collecting loan, acquiring and disposing of debt and equity instruments, property, plant, and equipment, and other productive assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_discontinued_investing_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from investing activity attributable to discontinued operation. Investing activity includes, but is not limited to, making and collecting loan, acquiring and disposing of debt and equity instruments, property, plant, and equipment, and other productive assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_investing_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from investing activity, including, but not limited to, discontinued operation. Investing activity includes, but is not limited to, making and collecting loan, acquiring and disposing of debt and equity instruments, property, plant, and equipment, and other productive assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "repayment_of_debt", + "type": "float | None", + "description": "The cash outflow for debt initially having maturity due after one year or beyond the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "repurchase_of_preferred_equity", + "type": "float | None", + "description": "The cash outflow to reacquire preferred stock during the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "repurchase_of_common_equity", + "type": "float | None", + "description": "The cash outflow to reacquire common stock during the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payment_of_dividends", + "type": "float | None", + "description": "Cash outflow in the form of capital distributions and dividends to common shareholders, preferred shareholders and noncontrolling interests.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuance_of_debt", + "type": "float | None", + "description": "The cash inflow from a debt initially having maturity due after one year or beyond the operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuance_of_preferred_equity", + "type": "float | None", + "description": "Proceeds from issuance of capital stock which provides for a specific dividend that is paid to the shareholders before any dividends to common stockholders and which takes precedence over common stockholders in the event of liquidation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuance_of_common_equity", + "type": "float | None", + "description": "The cash inflow from the additional capital contribution to the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_change_in_deposits", + "type": "float | None", + "description": "The net cash inflow or outflow for the increase (decrease) in the beginning and end of period deposits balances.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_debt_net", + "type": "float | None", + "description": "The net cash inflow or outflow for borrowing having initial term of repayment within one year or the normal operating cycle, if longer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tax_withholding_share_based_compensation", + "type": "float | None", + "description": "Amount of cash outflow to satisfy grantee's tax withholding obligation for award under share-based payment arrangement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_financing_activities_net", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from financing activity, classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_continuing_financing_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from financing activity, including, but not limited to, discontinued operation. Financing activity includes, but is not limited to, obtaining resource from owner and providing return on, and return of, their investment; borrowing money and repaying amount borrowed, or settling obligation; and obtaining and paying for other resource obtained from creditor on long-term credit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_discontinued_financing_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from financing activity attributable to discontinued operation. Financing activity includes, but is not limited to, obtaining resource from owner and providing return on, and return of, their investment; borrowing money and repaying amount borrowed, or settling obligation; and obtaining and paying for other resource obtained from creditor on long-term credit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_financing_activities", + "type": "float | None", + "description": "Amount of cash inflow (outflow) from financing activity, including, but not limited to, discontinued operation. Financing activity includes, but is not limited to, obtaining resource from owner and providing return on, and return of, their investment; borrowing money and repaying amount borrowed, or settling obligation; and obtaining and paying for other resource obtained from creditor on long-term credit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "effect_of_exchange_rate_changes", + "type": "float | None", + "description": "The effect of exchange rate changes on cash balances held in foreign currencies.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_cash_from_discontinued_operations", + "type": "float | None", + "description": "The net change in cash and cash equivalents resulting from the cash inflows and outflows of discontinued operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_net_changes_in_cash", + "type": "float | None", + "description": "Amount of other net changes in cash and cash equivalents not separately disclosed in the statement of cash flows.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_change_in_cash", + "type": "float | None", + "description": "The increase (decrease) during the reporting period in cash and cash equivalents. While for technical reasons this element has no balance attribute, the default assumption is a debit balance consistent with its label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_at_beginning_of_period", + "type": "float | None", + "description": "Cash, cash equivalents, restricted cash, and restricted cash equivalents at the beginning of the reporting period. Derived from the previous period's ending balance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_at_end_of_period", + "type": "float | None", + "description": "Cash, cash equivalents, restricted cash, and restricted cash equivalents at the end of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_interest_paid", + "type": "float | None", + "description": "Amount of cash paid for interest, excluding capitalized interest, classified as operating activity. Includes, but is not limited to, payment to settle zero-coupon bond for accreted interest of debt discount and debt instrument with insignificant coupon interest rate in relation to effective interest rate of borrowing attributable to accreted interest of debt discount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_interest_received", + "type": "float | None", + "description": "The cash inflow from interest received, classified as operating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_income_taxes_paid", + "type": "float | None", + "description": "Amount, after refund, of cash paid to foreign, federal, state, and local jurisdictions as income tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecCashFlowStatement", + "openapi_extra": { + "model": "SecCashFlowStatement" + } + }, + "/sec/cash_flow_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's cash flow statement items over time.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.cash_flow_growth(symbol='AAPL', provider='sec')\nobb.sec.cash_flow_growth(symbol='AAPL', limit=10, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache (4-hour memory) for the SEC request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_preliminary", + "type": "bool | None", + "description": "Whether to include preliminary data from 8-K filings for periods not yet reported on 10-Q/K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pit_mode", + "type": "bool | None", + "description": "Point-in-time mode. When True, returns data as originally reported at the time of filing, without subsequent restatements or amendments. For annual data, uses the original 10-K values. For quarterly data, preserves 10-Q filing vintage instead of using restated comparatives from the 10-K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecCashFlowStatementGrowth", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "growth_net_income", + "type": "float | None", + "description": "Growth rate of net income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_discontinued", + "type": "float | None", + "description": "Growth rate of net income from discontinued operations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_continuing", + "type": "float | None", + "description": "Growth rate of net income from continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_provision_for_loan_losses", + "type": "float | None", + "description": "Growth rate of provision for loan losses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_depreciation_expense", + "type": "float | None", + "description": "Growth rate of depreciation expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_amortization_expense", + "type": "float | None", + "description": "Growth rate of amortization expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float | None", + "description": "Growth rate of depreciation and amortization.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_stock_based_compensation", + "type": "float | None", + "description": "Growth rate of stock-based compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_deferred_income_tax", + "type": "float | None", + "description": "Growth rate of deferred income tax.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_gain_loss_on_investments", + "type": "float | None", + "description": "Growth rate of gain/loss on investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_gain_loss_on_sale_of_assets", + "type": "float | None", + "description": "Growth rate of gain/loss on sale of assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_income_loss_from_equity_method_investments", + "type": "float | None", + "description": "Growth rate of income/loss from equity method investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_asset_impairment_charges", + "type": "float | None", + "description": "Growth rate of asset impairment charges.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_noncash_adjustments_to_net_income", + "type": "float | None", + "description": "Growth rate of noncash adjustments to net income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_operating_activities", + "type": "float | None", + "description": "Growth rate of other operating activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_change_in_insurance_reserves", + "type": "float | None", + "description": "Growth rate of change in insurance reserves.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_change_in_accounts_receivable", + "type": "float | None", + "description": "Growth rate of change in accounts receivable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_change_in_nontrade_receivables", + "type": "float | None", + "description": "Growth rate of change in nontrade receivables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_change_in_inventories", + "type": "float | None", + "description": "Growth rate of change in inventories.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_change_in_accounts_payable", + "type": "float | None", + "description": "Growth rate of change in accounts payable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_change_in_other_operating_assets_and_liabilities", + "type": "float | None", + "description": "Growth rate of change in other operating assets and liabilities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_increase_decrease_in_operating_capital", + "type": "float | None", + "description": "Growth rate of increase/decrease in operating capital.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_continuing_operating_activities", + "type": "float | None", + "description": "Growth rate of net cash from continuing operating activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_discontinued_operating_activities", + "type": "float | None", + "description": "Growth rate of net cash from discontinued operating activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_operating_activities", + "type": "float | None", + "description": "Growth rate of net cash from operating activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_purchase_of_plant_property_and_equipment", + "type": "float | None", + "description": "Growth rate of purchase of plant, property, and equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_acquisitions", + "type": "float | None", + "description": "Growth rate of acquisitions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_purchase_of_investments", + "type": "float | None", + "description": "Growth rate of purchase of investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_purchase_of_held_to_maturity_investments", + "type": "float | None", + "description": "Growth rate of purchase of held-to-maturity investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_sale_of_plant_property_and_equipment", + "type": "float | None", + "description": "Growth rate of sale of plant, property, and equipment.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_sale_of_productive_assets", + "type": "float | None", + "description": "Growth rate of sale of productive assets.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_divestitures", + "type": "float | None", + "description": "Growth rate of divestitures.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_sale_of_investments", + "type": "float | None", + "description": "Growth rate of sale of investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_maturity_of_investments", + "type": "float | None", + "description": "Growth rate of maturity of investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_increase_in_fed_funds_sold", + "type": "float | None", + "description": "Growth rate of net increase in federal funds sold.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_loans_held_for_sale_net", + "type": "float | None", + "description": "Growth rate of loans held for sale, net.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_investing_activities_net", + "type": "float | None", + "description": "Growth rate of other investing activities, net.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_continuing_investing_activities", + "type": "float | None", + "description": "Growth rate of net cash from continuing investing activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_discontinued_investing_activities", + "type": "float | None", + "description": "Growth rate of net cash from discontinued investing activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_investing_activities", + "type": "float | None", + "description": "Growth rate of net cash from investing activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_repayment_of_debt", + "type": "float | None", + "description": "Growth rate of repayment of debt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_repurchase_of_preferred_equity", + "type": "float | None", + "description": "Growth rate of repurchase of preferred equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_repurchase_of_common_equity", + "type": "float | None", + "description": "Growth rate of repurchase of common equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_payment_of_dividends", + "type": "float | None", + "description": "Growth rate of payment of dividends.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_issuance_of_debt", + "type": "float | None", + "description": "Growth rate of issuance of debt.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_issuance_of_preferred_equity", + "type": "float | None", + "description": "Growth rate of issuance of preferred equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_issuance_of_common_equity", + "type": "float | None", + "description": "Growth rate of issuance of common equity.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_change_in_deposits", + "type": "float | None", + "description": "Growth rate of net change in deposits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_short_term_borrowings", + "type": "float | None", + "description": "Growth rate of net short-term borrowings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_tax_withholding_share_based_compensation", + "type": "float | None", + "description": "Growth rate of tax withholding for share-based compensation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_financing_activities_net", + "type": "float | None", + "description": "Growth rate of other financing activities, net.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_continuing_financing_activities", + "type": "float | None", + "description": "Growth rate of net cash from continuing financing activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_discontinued_financing_activities", + "type": "float | None", + "description": "Growth rate of net cash from discontinued financing activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_financing_activities", + "type": "float | None", + "description": "Growth rate of net cash from financing activities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_effect_of_exchange_rate_changes", + "type": "float | None", + "description": "Growth rate of effect of exchange rate changes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_cash_from_discontinued_operations", + "type": "float | None", + "description": "Growth rate of net cash from discontinued operations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_net_changes_in_cash", + "type": "float | None", + "description": "Growth rate of other net changes in cash.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_change_in_cash", + "type": "float | None", + "description": "Growth rate of net change in cash.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_cash_at_beginning_of_period", + "type": "float | None", + "description": "Growth rate of cash at beginning of period.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_cash_at_end_of_period", + "type": "float | None", + "description": "Growth rate of cash at end of period.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_cash_interest_paid", + "type": "float | None", + "description": "Growth rate of cash interest paid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_cash_interest_received", + "type": "float | None", + "description": "Growth rate of cash interest received.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_cash_income_taxes_paid", + "type": "float | None", + "description": "Growth rate of cash income taxes paid.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "SecCashFlowStatementGrowth", + "openapi_extra": { + "model": "SecCashFlowStatementGrowth" + } + }, + "/sec/income_statement": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the income statement for a given company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.income_statement(symbol='AAPL', provider='sec')\nobb.sec.income_statement(symbol='AAPL', period='annual', limit=5, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache (4-hour memory) for the SEC request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_preliminary", + "type": "bool | None", + "description": "Whether to include preliminary data from 8-K filings for periods not yet reported on 10-Q/K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pit_mode", + "type": "bool | None", + "description": "Point-in-time mode. When True, returns data as originally reported at the time of filing, without subsequent restatements or amendments. For annual data, uses the original 10-K values. For quarterly data, preserves 10-Q filing vintage instead of using restated comparatives from the 10-K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecIncomeStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "reported_currency", + "type": "str | None", + "description": "The currency in which the income statement is reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_revenue", + "type": "float | None", + "description": "Amount of revenue recognized from goods sold, services rendered, insurance premiums, or other activities that constitute an earning process. Includes, but is not limited to, investment and interest income before deduction of interest expense when recognized as a component of revenue, and sales and trading gain (loss).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_revenue", + "type": "float | None", + "description": "Revenues from the sale of other goods or rendering of other services, not elsewhere specified in the taxonomy; net of (reduced by) sales adjustments, returns, allowances, and discounts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_revenue", + "type": "float | None", + "description": "Amount of revenue recognized from goods sold, services rendered, insurance premiums, or other activities that constitute an earning process. Includes, but is not limited to, investment and interest income before deduction of interest expense when recognized as a component of revenue, and sales and trading gain (loss).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_cost_of_revenue", + "type": "float | None", + "description": "The aggregate costs related to goods produced and sold and services rendered by an entity during the reporting period. This excludes costs incurred during the reporting period related to financial services rendered and other revenue generating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_cost_of_revenue", + "type": "float | None", + "description": "Other costs incurred during the reporting period related to other revenue generating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_cost_of_revenue", + "type": "float | None", + "description": "The aggregate costs related to goods produced and sold and services rendered by an entity during the reporting period. This excludes costs incurred during the reporting period related to financial services rendered and other revenue generating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "excise_and_sales_taxes", + "type": "float | None", + "description": "Amount of excise and sales taxes included in revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_gross_profit", + "type": "float | None", + "description": "Aggregate revenue less cost of goods and services sold or operating expenses directly attributable to the revenue generation activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sga_expense", + "type": "float | None", + "description": "The aggregate total costs related to selling a firm's product and services, as well as all other general and administrative expenses. Direct selling expenses (for example, credit, warranty, and advertising) are expenses that can be directly linked to the sale of specific products. Indirect selling expenses are expenses that cannot be directly linked to the sale of specific products, for example telephone expenses, Internet, and postal charges. General and administrative expenses include salaries of non-sales personnel, rent, utilities, communication, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rd_expense", + "type": "float | None", + "description": "Amount of expense for research and development. Includes, but is not limited to, cost for computer software product to be sold, leased, or otherwise marketed and writeoff of research and development assets acquired in transaction other than business combination or joint venture formation or both. Excludes write-down of intangible asset acquired in business combination or from joint venture formation or both, used in research and development activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exploration_expense", + "type": "float | None", + "description": "Exploration expenses (including prospecting) related to oil and gas producing entities and would be included in operating expenses of that entity. Costs incurred in identifying areas that may warrant examination and in examining specific areas that are considered to have prospects of containing oil and gas reserves, including costs of drilling exploratory wells and exploratory-type stratigraphic test wells. Exploration costs may be incurred both before acquiring the related property (sometimes referred to in part as prospecting costs) and after acquiring the property. Principal types of exploration costs, which include depreciation and applicable operating costs of support equipment and facilities and other costs of exploration activities, are: (i) Costs of topographical, geographical and geophysical studies, rights of access to properties to conduct those studies, and salaries and other expenses of geologists, geophysical crews, and others conducting those studies. Collectively, these are sometimes referred to as geological and geophysical or 'G&G' costs. (ii) Costs of carrying and retaining undeveloped properties, such as delay rentals, ad valorem taxes on properties, legal costs for title defense, and the maintenance of land and lease records. (iii) Dry hole contributions and bottom hole contributions. (iv) Costs of drilling and equipping exploratory wells. (v) Costs of drilling exploratory-type stratigraphic test wells.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_expense", + "type": "float | None", + "description": "The current period expense charged against earnings on long-lived, physical assets not used in production, and which are not intended for resale, to allocate or recognize the cost of such assets over their useful lives; or to record the reduction in book value of an intangible asset over the benefit period of such asset; or to reflect consumption during the period of an asset that is not used in production.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_expense", + "type": "float | None", + "description": "Amount of amortization expense for finite-lived intangible asset. Excludes goodwill and capitalized cost for software to be sold, leased, or marketed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_and_amortization", + "type": "float | None", + "description": "The aggregate expense recognized in the current period that allocates the cost of tangible and intangible assets over their useful lives.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depletion_expense", + "type": "float | None", + "description": "The noncash expense charged against earnings to recognize the consumption of natural resources.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_operating_expenses", + "type": "float | None", + "description": "The net amount of other operating income and expenses, the components of which are not separately disclosed on the income statement, from items that are associated with the entity's normal revenue producing operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "impairment_expense", + "type": "float | None", + "description": "Amount of impairment loss for asset. Includes, but is not limited to, tangible and intangible assets and goodwill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restructuring_charge", + "type": "float | None", + "description": "Amount of expenses associated with exit or disposal activities pursuant to an authorized plan. Excludes expenses related to a discontinued operation or an asset retirement obligation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_special_charges", + "type": "float | None", + "description": "Amount of restructuring charges, remediation cost, and asset impairment loss.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_operating_expenses", + "type": "float | None", + "description": "Generally recurring costs associated with normal operations except for the portion of these expenses which can be clearly related to production and included in cost of sales or services. Includes selling, general and administrative expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "costs_and_expenses", + "type": "float | None", + "description": "Total costs of sales and operating expenses for the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_operating_income", + "type": "float | None", + "description": "The net result for the period of deducting operating expenses from operating revenues.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loans_and_lease_interest_income", + "type": "float | None", + "description": "The aggregate interest and fee income generated by: (1) loans the Entity has positive intent and ability to hold for the foreseeable future, or until maturity or payoff, including commercial and consumer loans, whether domestic or foreign, which may consist of: (a) industrial and agricultural; (b) real estate; and (c) real estate construction loans; (d) trade financing; (e) lease financing; (f) home equity lines-of-credit; (g) automobile and other vehicle loans; and (h) credit card and other revolving-type loans and (2) loans and leases held-for-sale which may include mortgage loans, direct financing, and sales-type leases.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_securities_interest_income", + "type": "float | None", + "description": "Amount of operating interest income, including amortization and accretion of premiums and discounts, on securities subject to state, federal and other income tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deposits_interest_income", + "type": "float | None", + "description": "Interest income derived from funds deposited with both domestic and foreign financial institutions including funds in money market and other accounts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fed_funds_and_repo_interest_income", + "type": "float | None", + "description": "The aggregate interest income earned from (1) the lending of excess federal funds to another commercial bank requiring such for its legal reserve requirements and (2) securities purchased under agreements to resell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trading_account_interest_income", + "type": "float | None", + "description": "Interest and dividend income on securities that are bought and held principally for the purpose of selling them in the near term ('trading securities') and on securities measured at fair value through earnings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_interest_income", + "type": "float | None", + "description": "Amount of interest income earned from interest bearing assets classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_interest_income", + "type": "float | None", + "description": "Amount of operating interest income, including, but not limited to, amortization and accretion of premiums and discounts on securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deposits_interest_expense", + "type": "float | None", + "description": "Aggregate amount of interest expense on all deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_borrowing_interest_expense", + "type": "float | None", + "description": "The aggregate interest expense incurred on short-term borrowings including commercial paper and Federal funds purchased and securities sold under agreements to repurchase.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt_interest_expense", + "type": "float | None", + "description": "Aggregate amount of interest paid or due on all long-term debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fed_funds_and_repo_interest_expense", + "type": "float | None", + "description": "The aggregate expense incurred on federal funds purchased and securities sold under agreements to repurchase. If amounts recognized as payables under repurchase agreements have been offset against amounts recognized as receivables under reverse repurchase agreements and reported as a net amount on the balance sheet, the income and expense from these agreements may be reported on a net basis.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capitalized_lease_obligation_interest_expense", + "type": "float | None", + "description": "Amount of interest expense on finance lease liability.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_interest_expense", + "type": "float | None", + "description": "Amount of interest expense classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_interest_expense", + "type": "float | None", + "description": "Amount of interest expense classified as operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_interest_income", + "type": "float | None", + "description": "Amount of interest income (expense) classified as operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenues_excl_interest_dividends", + "type": "float | None", + "description": "Revenue excluding interest and dividend income (securities firms).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trust_fee_income", + "type": "float | None", + "description": "Revenue recognized in the period for (1) performance (incentive) fees based on the investment results achieved for management of certain institutional accounts and hedge funds, (2) schedule-based fees earned for management of mutual funds and closed-end funds, based either on average daily net assets or on a combination of the average daily net assets and gross income, and (3) other investment management and advisory fees.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "service_charges_on_deposits_income", + "type": "float | None", + "description": "Includes amounts charged depositors for: (1) maintenance of their accounts (maintenance charges); (2) failure to maintain specified minimum balances on account; (3) exceeding the number of checks or transactions allowed to be processed in a given period; (4) checks drawn on no minimum balance deposit accounts; (5) withdrawals from nontransaction deposit accounts; (6) closing savings accounts before a specified minimum period of time has elapsed; (7) accounts which have remained inactive for extended periods of time or which have become dormant; (8) use of automated teller machines or remote service units; (9) checks drawn against insufficient funds that the bank assesses regardless of whether it decides to pay, return or hold the check; (10) issuing stop payment orders; (11) certifying checks; and (12) accumulating or disbursing funds deposited in IRAs or Keogh Plan accounts when not handled by the bank's trust department. This item does not include penalties assessed on the early withdrawal of time deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_service_charge_income", + "type": "float | None", + "description": "Fee and commission revenue earned from sources not otherwise specified in the existing taxonomy.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_realized_capital_gains", + "type": "float | None", + "description": "Amount of realized and unrealized gain (loss) on investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "premiums_earned", + "type": "float | None", + "description": "Amount, after premiums ceded to other entities and premiums assumed by the entity, of premiums earned.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_banking_income", + "type": "float | None", + "description": "Amount of fees and commissions from banking, advisory, brokerage, and securities underwriting activities. Activities include, but are not limited to, underwriting securities, private placements of securities, investment advisory and management services, merger and acquisition services, sale and servicing of mutual funds, and other related consulting fees.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_noninterest_income", + "type": "float | None", + "description": "Represents the total of noninterest income derived from certain activities and assets including (for example): (1) venture capital investments; (2) bank owned life insurance; (3) foreign currency transactions; and (4) mortgage servicing rights.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_noninterest_income", + "type": "float | None", + "description": "The total amount of noninterest income which may be derived from: (1) fees and commissions; (2) premiums earned; (3) insurance policy charges; (4) the sale or disposal of assets; and (5) other sources not otherwise specified.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "provision_for_credit_losses", + "type": "float | None", + "description": "Amount of expense related to estimated loss from loan and lease transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_interest_income_after_provision", + "type": "float | None", + "description": "Amount of net interest income after provision for credit losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "benefits_costs_expenses", + "type": "float | None", + "description": "The total amount of expense recognized during the period for future policy benefits, claims and claims adjustment costs, and for selling, general and administrative costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_and_future_benefits", + "type": "float | None", + "description": "Amount, after effect of policies assumed or ceded, of expense related to provision for policy benefits and costs incurred for health insurance contracts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "salaries_and_employee_benefits_expense", + "type": "float | None", + "description": "Amount of expense for salary, wage, profit sharing; incentive and equity-based compensation; and other employee benefit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_occupancy_equipment_expense", + "type": "float | None", + "description": "Amount of net occupancy expense that may include items, such as depreciation of facilities and equipment, lease expenses, property taxes and property and casualty insurance expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "marketing_expense", + "type": "float | None", + "description": "The aggregate total amount of expenses directly related to the marketing or selling of products or services.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "property_liability_insurance_claims", + "type": "float | None", + "description": "Amount, after effects of policies assumed or ceded, of expense related to the provision for policy benefits and costs incurred.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "policy_acquisition_costs", + "type": "float | None", + "description": "Amount of deferred policy acquisition cost capitalized on contract remaining in force.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_of_deferred_policy_acquisition_costs", + "type": "float | None", + "description": "Amount of amortization expense (reversal of expense) for deferred policy acquisition costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_noninterest_expense", + "type": "float | None", + "description": "Total aggregate amount of all noninterest expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_operating_income", + "type": "float | None", + "description": "The aggregate amount of income or expense from ancillary business-related activities (that is to say, excluding major activities considered part of the normal operations of the business).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_income", + "type": "float | None", + "description": "Amount of income (expense) related to nonoperating activities, classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_gains", + "type": "float | None", + "description": "Amount of realized and unrealized gain (loss) on investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_other_income", + "type": "float | None", + "description": "The aggregate amount of income or expense from ancillary business-related activities (that is to say, excluding major activities considered part of the normal operations of the business).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_pretax_income", + "type": "float | None", + "description": "Amount of income (loss) from continuing operations, including income (loss) from equity method investments, before deduction of income tax expense (benefit), and income (loss) attributable to noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_tax_expense", + "type": "float | None", + "description": "Amount of current income tax expense (benefit) and deferred income tax expense (benefit) pertaining to continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_tax_current", + "type": "float | None", + "description": "Amount of current income tax expense (benefit) pertaining to taxable income (loss) from continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_tax_deferred", + "type": "float | None", + "description": "Amount of deferred income tax expense (benefit) pertaining to income (loss) from continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_before_equity_method", + "type": "float | None", + "description": "Amount of income/loss from continuing operations before income from equity method investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_method_investments", + "type": "float | None", + "description": "Amount of income (loss) for proportionate share of equity method investee's income (loss).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_continuing", + "type": "float | None", + "description": "Amount after tax of income (loss) from continuing operations including portion attributable to the noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_discontinued", + "type": "float | None", + "description": "Amount after tax of income (loss) from a discontinued operation including the portion attributable to the noncontrolling interest. Includes, but is not limited to, the income (loss) from operations during the phase-out period, gain (loss) on disposal, gain (loss) for reversal of write-down (write-down) to fair value, less cost to sell, and adjustments to a prior period gain (loss) on disposal.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "extraordinary_income", + "type": "float | None", + "description": "Description of the gains (losses), after tax, arising from an event or transaction that is both unusual in nature and infrequent in occurrence when considered in relation to the environment in which the entity operates and which represents the portion assigned to noncontrolling interest, if any. This amount is the income statement amount which is allocable to that ownership interest in subsidiary equity which is not attributable to the parent (noncontrolling interest, minority interest).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_adjustments_to_consolidated_net_income", + "type": "float | None", + "description": "Amount after tax and reclassification adjustments of other comprehensive income (loss).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_on_sale_properties", + "type": "float | None", + "description": "Amount of gain (loss) on sale or disposal of property, net of applicable income taxes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_loss_disposition_subsidiary", + "type": "float | None", + "description": "Gain/loss on sale of stock in subsidiary or equity method investee.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "float | None", + "description": "The consolidated profit or loss for the period, net of income taxes, including the portion attributable to the noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_dividends", + "type": "float | None", + "description": "Amount of paid and unpaid preferred stock dividends declared with the form of settlement in cash, stock and payment-in-kind (PIK).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_nci_redeemable", + "type": "float | None", + "description": "Amount after tax of income attributable to redeemable noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_nci_nonredeemable", + "type": "float | None", + "description": "Amount after tax of income attributable to nonredeemable noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_to_noncontrolling_interest", + "type": "float | None", + "description": "Amount of Net Income (Loss) attributable to noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_adjustments_to_net_income_to_common", + "type": "float | None", + "description": "The aggregate value of preferred stock dividends and other adjustments necessary to derive net income apportioned to common stockholders.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_to_common", + "type": "float | None", + "description": "Amount, after deduction of tax, noncontrolling interests, dividends on preferred stock and participating securities; of income (loss) available to common shareholders.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_ave_basic_shares_os", + "type": "int | None", + "description": "Number of [basic] shares or units, after adjustment for contingently issuable shares or units and other shares or units not deemed outstanding, determined by relating the portion of time within a reporting period that common shares or units have been outstanding to the total time in that period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basic_eps", + "type": "float | None", + "description": "The amount of net income (loss) for the period per each share of common stock or unit outstanding during the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_ave_diluted_shares_os", + "type": "int | None", + "description": "The average number of shares or units issued and outstanding that are used in calculating diluted EPS or earnings per unit (EPU), determined based on the timing of issuance of shares or units in the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diluted_eps", + "type": "float | None", + "description": "The amount of net income (loss) for the period available to each share of common stock or common unit outstanding during the reporting period and to each share or unit that would have been outstanding assuming the issuance of common shares or units for all dilutive potential common shares or units outstanding during the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_ave_basic_diluted_shares_os", + "type": "int | None", + "description": "Average number of shares or units issued and outstanding that are used in calculating basic and diluted earnings per share (EPS).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basic_diluted_eps", + "type": "float | None", + "description": "The amount of net income or loss for the period per each share in instances when basic and diluted earnings per share are the same amount and reported as a single line item on the face of the financial statements. Basic earnings per share is the amount of net income or loss for the period per each share of common stock or unit outstanding during the reporting period. Diluted earnings per share includes the amount of net income or loss for the period available to each share of common stock or common unit outstanding during the reporting period and to each share or unit that would have been outstanding assuming the issuance of common shares or units for all dilutive potential common shares or units outstanding during the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_dividends_per_share", + "type": "float | None", + "description": "Aggregate dividends declared during the period for each share of common stock outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_comprehensive_income_parent", + "type": "float | None", + "description": "Amount after tax and reclassification adjustments of OCI attributable to parent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "comprehensive_income_parent", + "type": "float | None", + "description": "Amount after tax of increase (decrease) in equity from transactions and other events, attributable to parent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_comprehensive_income_nci", + "type": "float | None", + "description": "Amount after tax and reclassification adjustments of OCI attributable to noncontrolling interests.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "comprehensive_income_nci", + "type": "float | None", + "description": "Amount after tax of increase (decrease) in equity from transactions and other events, attributable to noncontrolling interests.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "comprehensive_income", + "type": "float | None", + "description": "Amount after tax of increase (decrease) in equity from transactions and other events/circumstances from net income and OCI. Includes portion attributable to NCI.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecIncomeStatement", + "openapi_extra": { + "model": "SecIncomeStatement" + } + }, + "/sec/income_statement_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth of a company's income statement items over time.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.income_statement_growth(symbol='AAPL', provider='sec')\nobb.sec.income_statement_growth(symbol='AAPL', limit=10, period='annual', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache (4-hour memory) for the SEC request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_preliminary", + "type": "bool | None", + "description": "Whether to include preliminary data from 8-K filings for periods not yet reported on 10-Q/K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pit_mode", + "type": "bool | None", + "description": "Point-in-time mode. When True, returns data as originally reported at the time of filing, without subsequent restatements or amendments. For annual data, uses the original 10-K values. For quarterly data, preserves 10-Q filing vintage instead of using restated comparatives from the 10-K.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecIncomeStatementGrowth", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "growth_operating_revenue", + "type": "float | None", + "description": "Growth rate of operating revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_revenue", + "type": "float | None", + "description": "Growth rate of other revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_revenue", + "type": "float | None", + "description": "Growth rate of total revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_operating_cost_of_revenue", + "type": "float | None", + "description": "Growth rate of operating cost of revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_cost_of_revenue", + "type": "float | None", + "description": "Growth rate of other cost of revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_cost_of_revenue", + "type": "float | None", + "description": "Growth rate of total cost of revenue.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_excise_and_sales_taxes", + "type": "float | None", + "description": "Growth rate of excise and sales taxes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_gross_profit", + "type": "float | None", + "description": "Growth rate of total gross profit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_sga_expense", + "type": "float | None", + "description": "Growth rate of selling, general, and administrative expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_rd_expense", + "type": "float | None", + "description": "Growth rate of research and development expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_exploration_expense", + "type": "float | None", + "description": "Growth rate of exploration expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_depreciation_expense", + "type": "float | None", + "description": "Growth rate of depreciation expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_amortization_expense", + "type": "float | None", + "description": "Growth rate of amortization expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_depreciation_and_amortization", + "type": "float | None", + "description": "Growth rate of depreciation and amortization.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_depletion_expense", + "type": "float | None", + "description": "Growth rate of depletion expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_operating_expenses", + "type": "float | None", + "description": "Growth rate of other operating expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_impairment_expense", + "type": "float | None", + "description": "Growth rate of impairment expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_restructuring_charge", + "type": "float | None", + "description": "Growth rate of restructuring charge.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_special_charges", + "type": "float | None", + "description": "Growth rate of other special charges.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_operating_expenses", + "type": "float | None", + "description": "Growth rate of total operating expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_costs_and_expenses", + "type": "float | None", + "description": "Growth rate of costs and expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_operating_income", + "type": "float | None", + "description": "Growth rate of total operating income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_loans_and_lease_interest_income", + "type": "float | None", + "description": "Growth rate of loans and lease interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_investment_securities_interest_income", + "type": "float | None", + "description": "Growth rate of investment securities interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_deposits_interest_income", + "type": "float | None", + "description": "Growth rate of deposits interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_fed_funds_and_repo_interest_income", + "type": "float | None", + "description": "Growth rate of federal funds and repo interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_trading_account_interest_income", + "type": "float | None", + "description": "Growth rate of trading account interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_interest_income", + "type": "float | None", + "description": "Growth rate of other interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_interest_income", + "type": "float | None", + "description": "Growth rate of total interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_deposits_interest_expense", + "type": "float | None", + "description": "Growth rate of deposits interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_short_term_borrowing_interest_expense", + "type": "float | None", + "description": "Growth rate of short-term borrowing interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_long_term_debt_interest_expense", + "type": "float | None", + "description": "Growth rate of long-term debt interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_fed_funds_and_repo_interest_expense", + "type": "float | None", + "description": "Growth rate of federal funds and repo interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_capitalized_lease_obligation_interest_expense", + "type": "float | None", + "description": "Growth rate of capitalized lease obligation interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_interest_expense", + "type": "float | None", + "description": "Growth rate of other interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_interest_expense", + "type": "float | None", + "description": "Growth rate of total interest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_interest_income", + "type": "float | None", + "description": "Growth rate of net interest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_revenues_excl_interest_dividends", + "type": "float | None", + "description": "Growth rate of revenues excluding interest and dividends.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_trust_fee_income", + "type": "float | None", + "description": "Growth rate of trust fee income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_service_charges_on_deposits_income", + "type": "float | None", + "description": "Growth rate of service charges on deposit accounts.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_service_charge_income", + "type": "float | None", + "description": "Growth rate of other service charge income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_realized_capital_gains", + "type": "float | None", + "description": "Growth rate of net realized and unrealized capital gains on investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_premiums_earned", + "type": "float | None", + "description": "Growth rate of premiums earned.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_investment_banking_income", + "type": "float | None", + "description": "Growth rate of investment banking income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_noninterest_income", + "type": "float | None", + "description": "Growth rate of other noninterest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_noninterest_income", + "type": "float | None", + "description": "Growth rate of total noninterest income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_provision_for_credit_losses", + "type": "float | None", + "description": "Growth rate of provision for credit losses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_interest_income_after_provision", + "type": "float | None", + "description": "Growth rate of net interest income after provision.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_benefits_costs_expenses", + "type": "float | None", + "description": "Growth rate of benefits, costs, and expenses.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_current_and_future_benefits", + "type": "float | None", + "description": "Growth rate of current and future benefits.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_salaries_and_employee_benefits_expense", + "type": "float | None", + "description": "Growth rate of salaries and employee benefits expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_occupancy_equipment_expense", + "type": "float | None", + "description": "Growth rate of net occupancy equipment expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_marketing_expense", + "type": "float | None", + "description": "Growth rate of marketing expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_property_liability_insurance_claims", + "type": "float | None", + "description": "Growth rate of property liability insurance claims.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_policy_acquisition_costs", + "type": "float | None", + "description": "Growth rate of policy acquisition costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_amortization_of_deferred_policy_acquisition_costs", + "type": "float | None", + "description": "Growth rate of amortization of deferred policy acquisition costs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_noninterest_expense", + "type": "float | None", + "description": "Growth rate of total noninterest expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_non_operating_income", + "type": "float | None", + "description": "Growth rate of non-operating income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_income", + "type": "float | None", + "description": "Growth rate of other income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_gains", + "type": "float | None", + "description": "Growth rate of other gains.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_other_income", + "type": "float | None", + "description": "Growth rate of total other income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_total_pretax_income", + "type": "float | None", + "description": "Growth rate of total pretax income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_income_tax_expense", + "type": "float | None", + "description": "Growth rate of income tax expense.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_income_tax_current", + "type": "float | None", + "description": "Growth rate of current income tax.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_income_tax_deferred", + "type": "float | None", + "description": "Growth rate of deferred income tax.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_income_before_equity_method", + "type": "float | None", + "description": "Growth rate of income before equity method.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_equity_method_investments", + "type": "float | None", + "description": "Growth rate of equity method investments.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_continuing", + "type": "float | None", + "description": "Growth rate of net income from continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_discontinued", + "type": "float | None", + "description": "Growth rate of net income from discontinued operations.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_extraordinary_income", + "type": "float | None", + "description": "Growth rate of extraordinary income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_adjustments_to_consolidated_net_income", + "type": "float | None", + "description": "Growth rate of other adjustments to consolidated net income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_gain_on_sale_properties", + "type": "float | None", + "description": "Growth rate of gain on sale of properties.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_gain_loss_disposition_subsidiary", + "type": "float | None", + "description": "Growth rate of gain/loss on disposition of subsidiary.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income", + "type": "float | None", + "description": "Growth rate of net income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_preferred_dividends", + "type": "float | None", + "description": "Growth rate of preferred dividends.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_nci_redeemable", + "type": "float | None", + "description": "Growth rate of net income NCI redeemable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_nci_nonredeemable", + "type": "float | None", + "description": "Growth rate of net income NCI nonredeemable.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_to_noncontrolling_interest", + "type": "float | None", + "description": "Growth rate of net income to noncontrolling interest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_adjustments_to_net_income_to_common", + "type": "float | None", + "description": "Growth rate of other adjustments to net income to common.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_net_income_to_common", + "type": "float | None", + "description": "Growth rate of net income to common.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_weighted_ave_basic_shares_os", + "type": "float | None", + "description": "Growth rate of weighted average basic shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_basic_eps", + "type": "float | None", + "description": "Growth rate of basic earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_weighted_ave_diluted_shares_os", + "type": "float | None", + "description": "Growth rate of weighted average diluted shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_diluted_eps", + "type": "float | None", + "description": "Growth rate of diluted earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_weighted_ave_basic_diluted_shares_os", + "type": "float | None", + "description": "Growth rate of weighted average basic/diluted shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_basic_diluted_eps", + "type": "float | None", + "description": "Growth rate of basic/diluted earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_cash_dividends_per_share", + "type": "float | None", + "description": "Growth rate of cash dividends per share.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_comprehensive_income_parent", + "type": "float | None", + "description": "Growth rate of other comprehensive income attributable to parent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_comprehensive_income_parent", + "type": "float | None", + "description": "Growth rate of comprehensive income attributable to parent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_other_comprehensive_income_nci", + "type": "float | None", + "description": "Growth rate of other comprehensive income attributable to NCI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_comprehensive_income_nci", + "type": "float | None", + "description": "Growth rate of comprehensive income attributable to NCI.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "growth_comprehensive_income", + "type": "float | None", + "description": "Growth rate of comprehensive income.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "SecIncomeStatementGrowth", + "openapi_extra": { + "model": "SecIncomeStatementGrowth" + } + }, + "/sec/company_filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get public company filings.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.company_filings(symbol='AAPL', provider='sec')\nobb.sec.company_filings(limit=100, provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/companies", + "style": { + "popupWidth": 950 + } + } + } + } + } + ], + "sec": [ + { + "name": "cik", + "type": "int | str | None", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "form_type", + "type": "str | None | list[str | None]", + "description": "SEC form type to filter by. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "1", + "1-A", + "1-A_POS", + "1-A-W", + "1-E", + "1-E_AD", + "1-K", + "1-SA", + "1-U", + "1-Z", + "1-Z-W", + "10-12B", + "10-12G", + "10-D", + "10-K", + "10-KT", + "10-Q", + "10-QT", + "11-K", + "11-KT", + "13F-HR", + "13F-NT", + "13FCONP", + "144", + "15-12B", + "15-12G", + "15-15D", + "15F-12B", + "15F-12G", + "15F-15D", + "18-12B", + "18-K", + "19B-4E", + "2-A", + "2-AF", + "2-E", + "20-F", + "20FR12B", + "20FR12G", + "24F-2NT", + "25", + "25-NSE", + "253G1", + "253G2", + "253G3", + "253G4", + "3", + "305B2", + "34-12H", + "4", + "40-17F1", + "40-17F2", + "40-17G", + "40-17GCS", + "40-202A", + "40-203A", + "40-206A", + "40-24B2", + "40-33", + "40-6B", + "40-8B25", + "40-8F-2", + "40-APP", + "40-F", + "40-OIP", + "40FR12B", + "40FR12G", + "424A", + "424B1", + "424B2", + "424B3", + "424B4", + "424B5", + "424B7", + "424B8", + "424H", + "425", + "485APOS", + "485BPOS", + "485BXT", + "486APOS", + "486BPOS", + "486BXT", + "487", + "497", + "497AD", + "497H2", + "497J", + "497K", + "497VPI", + "497VPU", + "5", + "6-K", + "6B_NTC", + "6B_ORDR", + "8-A12B", + "8-A12G", + "8-K", + "8-K12B", + "8-K12G3", + "8-K15D5", + "8-M", + "8F-2_NTC", + "8F-2_ORDR", + "9-M", + "ABS-15G", + "ABS-EE", + "ADN-MTL", + "ADV-E", + "ADV-H-C", + "ADV-H-T", + "ADV-NR", + "ANNLRPT", + "APP_NTC", + "APP_ORDR", + "APP_WD", + "APP_WDG", + "ARS", + "ATS-N", + "ATS-N-C", + "ATS-N/UA", + "AW", + "AW_WD", + "C", + "C-AR", + "C-AR-W", + "C-TR", + "C-TR-W", + "C-U", + "C-U-W", + "C-W", + "CB", + "CERT", + "CERTARCA", + "CERTBATS", + "CERTCBO", + "CERTNAS", + "CERTNYS", + "CERTPAC", + "CFPORTAL", + "CFPORTAL-W", + "CORRESP", + "CT_ORDER", + "D", + "DEF_14A", + "DEF_14C", + "DEFA14A", + "DEFA14C", + "DEFC14A", + "DEFC14C", + "DEFM14A", + "DEFM14C", + "DEFN14A", + "DEFR14A", + "DEFR14C", + "DEL_AM", + "DFAN14A", + "DFRN14A", + "DOS", + "DOSLTR", + "DRS", + "DRSLTR", + "DSTRBRPT", + "EFFECT", + "F-1", + "F-10", + "F-10EF", + "F-10POS", + "F-1MEF", + "F-3", + "F-3ASR", + "F-3D", + "F-3DPOS", + "F-3MEF", + "F-4", + "F-4_POS", + "F-4MEF", + "F-6", + "F-6_POS", + "F-6EF", + "F-7", + "F-7_POS", + "F-8", + "F-8_POS", + "F-80", + "F-80POS", + "F-9", + "F-9_POS", + "F-N", + "F-X", + "FOCUSN", + "FWP", + "G-405", + "G-405N", + "G-FIN", + "G-FINW", + "IRANNOTICE", + "MA", + "MA-A", + "MA-I", + "MA-W", + "MSD", + "MSDCO", + "MSDW", + "N-1", + "N-14", + "N-14_8C", + "N-14MEF", + "N-18F1", + "N-1A", + "N-2", + "N-2_POSASR", + "N-23C-2", + "N-23C3A", + "N-23C3B", + "N-23C3C", + "N-2ASR", + "N-2MEF", + "N-30B-2", + "N-30D", + "N-4", + "N-5", + "N-54A", + "N-54C", + "N-6", + "N-6F", + "N-8A", + "N-8B-2", + "N-8F", + "N-8F_NTC", + "N-8F_ORDR", + "N-CEN", + "N-CR", + "N-CSR", + "N-CSRS", + "N-MFP", + "N-MFP1", + "N-MFP2", + "N-PX", + "N-Q", + "N-VP", + "N-VPFS", + "NO_ACT", + "NPORT-EX", + "NPORT-NP", + "NPORT-P", + "NRSRO-CE", + "NRSRO-UPD", + "NSAR-A", + "NSAR-AT", + "NSAR-B", + "NSAR-BT", + "NSAR-U", + "NT_10-D", + "NT_10-K", + "NT_10-Q", + "NT_11-K", + "NT_20-F", + "NT_N-CEN", + "NT_N-MFP", + "NT_N-MFP1", + "NT_N-MFP2", + "NT_NPORT-EX", + "NT_NPORT-P", + "NT-NCEN", + "NT-NCSR", + "NT-NSAR", + "NTFNCEN", + "NTFNCSR", + "NTFNSAR", + "NTN_10D", + "NTN_10K", + "NTN_10Q", + "NTN_20F", + "OIP_NTC", + "OIP_ORDR", + "POS_8C", + "POS_AM", + "POS_AMI", + "POS_EX", + "POS462B", + "POS462C", + "POSASR", + "PRE_14A", + "PRE_14C", + "PREC14A", + "PREC14C", + "PREM14A", + "PREM14C", + "PREN14A", + "PRER14A", + "PRER14C", + "PRRN14A", + "PX14A6G", + "PX14A6N", + "QRTLYRPT", + "QUALIF", + "REG-NR", + "REVOKED", + "RW", + "RW_WD", + "S-1", + "S-11", + "S-11MEF", + "S-1MEF", + "S-20", + "S-3", + "S-3ASR", + "S-3D", + "S-3DPOS", + "S-3MEF", + "S-4", + "S-4_POS", + "S-4EF", + "S-4MEF", + "S-6", + "S-8", + "S-8_POS", + "S-B", + "S-BMEF", + "SBSE", + "SBSE-A", + "SBSE-BD", + "SBSE-C", + "SBSE-W", + "SC_13D", + "SC_13E1", + "SC_13E3", + "SC_13G", + "SC_14D9", + "SC_14F1", + "SC_14N", + "SC_TO-C", + "SC_TO-I", + "SC_TO-T", + "SC13E4F", + "SC14D1F", + "SC14D9C", + "SC14D9F", + "SD", + "SDR", + "SE", + "SEC_ACTION", + "SEC_STAFF_ACTION", + "SEC_STAFF_LETTER", + "SF-1", + "SF-3", + "SL", + "SP_15D2", + "STOP_ORDER", + "SUPPL", + "T-3", + "TA-1", + "TA-2", + "TA-W", + "TACO", + "TH", + "TTW", + "UNDER", + "UPLOAD", + "WDL-REQ", + "X-17A-5" + ], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "text", + "multiSelect": false, + "multiple": true + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache. If True, cache will store for one day.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecCompanyFilings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "Type of filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Document", + "pinned": "left", + "cellDataType": "text", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "url", + "valueField": "report_url" + } + } + } + } + }, + { + "name": "report_date", + "type": "date | None", + "description": "The date of the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "act", + "type": "int | str | None", + "description": "The SEC Act number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "items", + "type": "float | str | None", + "description": "The SEC Item numbers.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_doc_description", + "type": "str | None", + "description": "The description of the primary document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_doc", + "type": "str | None", + "description": "The filename of the primary document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accession_number", + "type": "int | str | None", + "description": "The accession number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "file_number", + "type": "int | str | None", + "description": "The file number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "film_number", + "type": "int | str | None", + "description": "The film number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_inline_xbrl", + "type": "int | str | None", + "description": "Whether the filing is an inline XBRL filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_xbrl", + "type": "int | str | None", + "description": "Whether the filing is an XBRL filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "size", + "type": "int | str | None", + "description": "The size of the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "complete_submission_url", + "type": "str | None", + "description": "The URL to the complete filing submission.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_detail_url", + "type": "str | None", + "description": "The URL to the filing details.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecCompanyFilings", + "openapi_extra": { + "model": "SecCompanyFilings" + } + }, + "/sec/compare_company_facts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compare reported company facts and fundamental data points.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.compare_company_facts(provider='sec')\nobb.sec.compare_company_facts(provider='sec', fact='PaymentsForRepurchaseOfCommonStock', year=2023)\nobb.sec.compare_company_facts(provider='sec', symbol='NVDA,AAPL,AMZN,MSFT,GOOG,SMCI', fact='RevenueFromContractWithCustomerExcludingAssessedTax', year=2024)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): sec.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "multiple_items_allowed": true + } + } + }, + { + "name": "fact", + "type": "str | None", + "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "multiple_items_allowed": false, + "choices": [ + "AccountsPayableCurrent", + "AccountsReceivableNet", + "AccountsReceivableNetCurrent", + "AccrualForTaxesOtherThanIncomeTaxesCurrent", + "AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent", + "AccruedIncomeTaxesCurrent", + "AccruedIncomeTaxesNoncurrent", + "AccruedInsuranceCurrent", + "AccruedLiabilitiesCurrent", + "AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment", + "AccumulatedOtherComprehensiveIncomeLossNetOfTax", + "AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets", + "AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue", + "AdvertisingExpense", + "AllocatedShareBasedCompensationExpense", + "AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount", + "AssetImpairmentCharges", + "Assets", + "AssetsCurrent", + "AssetsNoncurrent", + "BuildingsAndImprovementsGross", + "CapitalLeaseObligationsCurrent", + "CapitalLeaseObligationsNoncurrent", + "Cash", + "CashAndCashEquivalentsAtCarryingValue", + "CashCashEquivalentsAndShortTermInvestments", + "CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents", + "CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations", + "CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect", + "CommercialPaper", + "CommitmentsAndContingencies", + "CommonStockDividendsPerShareCashPaid", + "CommonStockDividendsPerShareDeclared", + "CommonStocksIncludingAdditionalPaidInCapital", + "ComprehensiveIncomeNetOfTax", + "ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest", + "ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest", + "ConstructionInProgressGross", + "ContractWithCustomerAssetNet", + "ContractWithCustomerLiability", + "ContractWithCustomerLiabilityCurrent", + "ContractWithCustomerLiabilityNoncurrent", + "CostOfGoodsAndServicesSold", + "CostOfRevenue", + "CurrentFederalTaxExpenseBenefit", + "CurrentForeignTaxExpenseBenefit", + "CurrentIncomeTaxExpenseBenefit", + "CurrentStateAndLocalTaxExpenseBenefit", + "DebtInstrumentFaceAmount", + "DebtInstrumentFairValue", + "DebtLongtermAndShorttermCombinedAmount", + "DeferredFederalIncomeTaxExpenseBenefit", + "DeferredForeignIncomeTaxExpenseBenefit", + "DeferredIncomeTaxExpenseBenefit", + "DeferredIncomeTaxLiabilities", + "DeferredIncomeTaxLiabilitiesNet", + "DeferredIncomeTaxesAndTaxCredits", + "DeferredRevenue", + "DeferredTaxAssetsGross", + "DeferredTaxAssetsLiabilitiesNet", + "DeferredTaxAssetsNet", + "DeferredTaxLiabilities", + "DefinedContributionPlanCostRecognized", + "Depreciation", + "DepreciationAmortizationAndAccretionNet", + "DepreciationAmortizationAndOther", + "DepreciationAndAmortization", + "DepreciationDepletionAndAmortization", + "DerivativeCollateralObligationToReturnCash", + "DerivativeCollateralRightToReclaimCash", + "DerivativeFairValueOfDerivativeNet", + "DerivativeLiabilityCollateralRightToReclaimCashOffset", + "DerivativeNotionalAmount", + "DistributedEarnings", + "Dividends", + "DividendsCash", + "DividendsPayableAmountPerShare", + "DividendsPayableCurrent", + "EarningsPerShareBasic", + "EarningsPerShareDiluted", + "EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents", + "EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations", + "EmployeeRelatedLiabilitiesCurrent", + "EmployeeRelatedLiabilitiesCurrentAndNoncurrent", + "EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense", + "FinanceLeaseInterestExpense", + "FinanceLeaseInterestPaymentOnLiability", + "FinanceLeaseLiability", + "FinanceLeaseLiabilityCurrent", + "FinanceLeaseLiabilityNoncurrent", + "FinanceLeaseLiabilityPaymentsDue", + "FinanceLeaseLiabilityPaymentsDueAfterYearFive", + "FinanceLeaseLiabilityPaymentsDueNextTwelveMonths", + "FinanceLeaseLiabilityPaymentsDueYearFive", + "FinanceLeaseLiabilityPaymentsDueYearFour", + "FinanceLeaseLiabilityPaymentsDueYearThree", + "FinanceLeaseLiabilityPaymentsDueYearTwo", + "FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear", + "FinanceLeaseLiabilityUndiscountedExcessAmount", + "FinanceLeasePrincipalPayments", + "FinanceLeaseRightOfUseAsset", + "FinancingReceivableAllowanceForCreditLosses", + "FiniteLivedIntangibleAssetsNet", + "FixturesAndEquipmentGross", + "GainLossOnInvestments", + "GainLossOnInvestmentsAndDerivativeInstruments", + "GainLossOnSaleOfBusiness", + "GainsLossesOnExtinguishmentOfDebt", + "GeneralAndAdministrativeExpense", + "Goodwill", + "GrossProfit", + "ImpairmentOfIntangibleAssetsExcludingGoodwill", + "ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill", + "IncomeLossFromContinuingOperations", + "IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity", + "IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest", + "IncomeLossFromContinuingOperationsPerBasicShare", + "IncomeLossFromContinuingOperationsPerDilutedShare", + "IncomeTaxExpenseBenefit", + "IncomeTaxesPaid", + "IncomeTaxesPaidNet", + "IncreaseDecreaseInAccountsAndOtherReceivables", + "IncreaseDecreaseInAccountsPayable", + "IncreaseDecreaseInAccountsReceivable", + "IncreaseDecreaseInAccruedIncomeTaxesPayable", + "IncreaseDecreaseInAccruedLiabilities", + "IncreaseDecreaseInAccruedTaxesPayable", + "IncreaseDecreaseInContractWithCustomerLiability", + "IncreaseDecreaseInDeferredIncomeTaxes", + "IncreaseDecreaseInInventories", + "IncreaseDecreaseInOtherCurrentAssets", + "IncreaseDecreaseInOtherCurrentLiabilities", + "IncreaseDecreaseInOtherNoncurrentAssets", + "IncreaseDecreaseInOtherNoncurrentLiabilities", + "IncreaseDecreaseInPensionPlanObligations", + "IncrementalCommonSharesAttributableToShareBasedPaymentArrangements", + "InterestAndDebtExpense", + "InterestExpenseDebt", + "InterestIncomeExpenseNet", + "InterestPaid", + "InterestPaidNet", + "InventoryNet", + "InvestmentIncomeInterest", + "Land", + "LeaseAndRentalExpense", + "LesseeOperatingLeaseLiabilityPaymentsDue", + "LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive", + "LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths", + "LesseeOperatingLeaseLiabilityPaymentsDueYearFive", + "LesseeOperatingLeaseLiabilityPaymentsDueYearFour", + "LesseeOperatingLeaseLiabilityPaymentsDueYearThree", + "LesseeOperatingLeaseLiabilityPaymentsDueYearTwo", + "LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear", + "LettersOfCreditOutstandingAmount", + "Liabilities", + "LiabilitiesAndStockholdersEquity", + "LiabilitiesCurrent", + "LineOfCredit", + "LineOfCreditFacilityMaximumBorrowingCapacity", + "LongTermDebt", + "LongTermDebtCurrent", + "LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive", + "LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths", + "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive", + "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour", + "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree", + "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo", + "LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear", + "LongTermDebtNoncurrent", + "LongTermInvestments", + "LossContingencyEstimateOfPossibleLoss", + "MachineryAndEquipmentGross", + "MarketableSecuritiesCurrent", + "MarketableSecuritiesNoncurrent", + "MinorityInterest", + "NetCashProvidedByUsedInFinancingActivities", + "NetCashProvidedByUsedInInvestingActivities", + "NetCashProvidedByUsedInOperatingActivities", + "NetIncomeLoss", + "NetIncomeLossAttributableToNoncontrollingInterest", + "NetIncomeLossAttributableToNonredeemableNoncontrollingInterest", + "NetIncomeLossAttributableToRedeemableNoncontrollingInterest", + "NoncurrentAssets", + "NoncurrentAssets", + "NoninterestIncome", + "NonoperatingIncomeExpense", + "NotesReceivableNet", + "OperatingExpenses", + "OperatingIncomeLoss", + "OperatingLeaseCost", + "OperatingLeaseLiability", + "OperatingLeaseLiabilityCurrent", + "OperatingLeaseLiabilityNoncurrent", + "OperatingLeaseRightOfUseAsset", + "OtherAccruedLiabilitiesCurrent", + "OtherAssetsCurrent", + "OtherAssetsNoncurrent", + "OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax", + "OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax", + "OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax", + "OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax", + "OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax", + "OtherComprehensiveIncomeLossNetOfTax", + "OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent", + "OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax", + "OtherIncome", + "OtherLiabilitiesCurrent", + "OtherLiabilitiesNoncurrent", + "OtherLongTermDebt", + "OtherNoncashIncomeExpense", + "PaymentsForCapitalImprovements", + "PaymentsForProceedsFromBusinessesAndInterestInAffiliates", + "PaymentsForProceedsFromOtherInvestingActivities", + "PaymentsForRent", + "PaymentsForRepurchaseOfCommonStock", + "PaymentsOfDebtExtinguishmentCosts", + "PaymentsOfDividends", + "PaymentsOfDividendsMinorityInterest", + "PaymentsToAcquireInvestments", + "PaymentsToAcquirePropertyPlantAndEquipment", + "PreferredStockSharesOutstanding", + "PreferredStockValue", + "PrepaidExpenseAndOtherAssetsCurrent", + "PrepaidExpenseCurrent", + "ProceedsFromDebtMaturingInMoreThanThreeMonths", + "ProceedsFromDebtNetOfIssuanceCosts", + "ProceedsFromDivestitureOfBusinesses", + "ProceedsFromInvestments", + "ProceedsFromIssuanceOfCommonStock", + "ProceedsFromIssuanceOfDebt", + "ProceedsFromIssuanceOfLongTermDebt", + "ProceedsFromIssuanceOfUnsecuredDebt", + "ProceedsFromIssuanceOrSaleOfEquity", + "ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities", + "ProceedsFromPaymentsForOtherFinancingActivities", + "ProceedsFromPaymentsToMinorityShareholders", + "ProceedsFromRepaymentsOfShortTermDebt", + "ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess", + "ProceedsFromSaleOfPropertyPlantAndEquipment", + "ProceedsFromStockOptionsExercised", + "ProfitLoss", + "PropertyPlantAndEquipmentGross", + "PropertyPlantAndEquipmentNet", + "ReceivablesNetCurrent", + "RedeemableNoncontrollingInterestEquityCarryingAmount", + "RepaymentsOfDebtMaturingInMoreThanThreeMonths", + "RepaymentsOfLongTermDebt", + "ResearchAndDevelopmentExpense", + "RestrictedCash", + "RestrictedCashAndCashEquivalents", + "RestrictedStockExpense", + "RestructuringCharges", + "RetainedEarningsAccumulatedDeficit", + "RevenueFromContractWithCustomerExcludingAssessedTax", + "Revenues", + "SecuredLongTermDebt", + "SellingAndMarketingExpense", + "SellingGeneralAndAdministrativeExpense", + "ShareBasedCompensation", + "ShortTermBorrowings", + "ShortTermInvestments", + "StockIssuedDuringPeriodValueNewIssues", + "StockOptionPlanExpense", + "StockRedeemedOrCalledDuringPeriodValue", + "StockRepurchasedAndRetiredDuringPeriodValue", + "StockRepurchasedDuringPeriodValue", + "StockholdersEquity", + "StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest", + "StockholdersEquityOther", + "TaxesPayableCurrent", + "TradingSecuritiesDebt", + "TreasuryStockAcquiredAverageCostPerShare", + "TreasuryStockSharesAcquired", + "UnrealizedGainLossOnInvestments", + "UnrecognizedTaxBenefits", + "UnsecuredDebt", + "VariableLeaseCost", + "WeightedAverageNumberDilutedSharesOutstandingAdjustment", + "WeightedAverageNumberOfDilutedSharesOutstanding", + "WeightedAverageNumberOfSharesOutstandingBasic" + ] + } + } + } + ], + "sec": [ + { + "name": "fact", + "type": "str | None", + "description": "Fact or concept from the SEC taxonomy, in UpperCamelCase. Defaults to, 'Revenues'. AAPL, MSFT, GOOG, BRK-A currently report revenue as, 'RevenueFromContractWithCustomerExcludingAssessedTax'. In previous years, they have reported as 'Revenues'.\nFacts fall into two groups. Instantaneous balance-sheet concepts are measured at a point in time (e.g. 'Assets', 'Liabilities', 'StockholdersEquity', 'Goodwill', 'LongTermDebt'); the full set is openbb_sec.utils.definitions.INSTANT_FACTS. Everything else is a flow concept from the income or cash-flow statement, measured over a period (e.g. 'Revenues', 'NetIncomeLoss', 'NetCashProvidedByUsedInOperatingActivities'). The 'instantaneous' parameter and the standalone-Q4 derivation apply only to flow concepts; balance-sheet concepts are always point-in-time, including the year-end (Q4) value.", + "default": "Revenues", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int | None", + "description": "The calendar year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. Values are aligned by the calendar quarter/year of the period end, not the fiscal calendar.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "The calendar period to retrieve the data for. Periods are aligned to the calendar quarter/year of the report period end, not the filer's fiscal calendar, so off-calendar filers stay comparable. If not provided, the most recent quarter is used. 'q1'-'q4' return standalone (3-month) quarters; the fourth quarter is derived as FY - 9-month. When a symbol is supplied, cumulative year-to-date values are reduced to standalone quarters.", + "default": null, + "optional": true, + "choices": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "instantaneous", + "type": "bool | None", + "description": "Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.\nThe function will automatically attempt the inverse of this parameter if the initial calendar quarter request fails. This parameter is ignored when a symbol is supplied.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use cache for the request. Defaults to True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecCompareCompanyFacts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "The reported value of the fact or concept.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "reported_date", + "type": "date | None", + "description": "The date when the report was filed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_beginning", + "type": "date | None", + "description": "The start date of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "date | None", + "description": "The end date of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the fiscal year.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "cik", + "type": "int | str", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "location", + "type": "str | None", + "description": "Geographic location of the reporting entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "form", + "type": "str | None", + "description": "The SEC form associated with the fact or concept.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frame", + "type": "str | None", + "description": "The frame ID associated with the fact or concept, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accession", + "type": "str", + "description": "SEC filing accession number associated with the reported fact or concept.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fact", + "type": "str", + "description": "The display name of the fact or concept.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "The unit of measurement for the fact or concept.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year the value is aligned to (by the calendar quarter/year of the period end, not the fiscal calendar).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar period the value is aligned to: 'FY' or 'Q1'-'Q4'.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecCompareCompanyFacts", + "openapi_extra": { + "model": "SecCompareCompanyFacts" + } + }, + "/sec/equity_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search for stock symbol, CIK, LEI, or company name.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.equity_search(provider='sec')\nobb.sec.equity_search(query='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the cache or not.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_fund", + "type": "bool | None", + "description": "Whether to direct the search to the list of mutual funds and ETFs.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecEquitySearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "cik", + "type": "str", + "description": "Central Index Key", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecEquitySearch", + "openapi_extra": { + "model": "SecEquitySearch" + } + }, + "/sec/latest_financial_reports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the newest quarterly, annual, and current reports for all companies.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.latest_financial_reports(provider='sec')\nobb.sec.latest_financial_reports(provider='sec', date='2024-09-30')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "date", + "type": "date | None | str", + "description": "A specific date to get data for. Defaults to today.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None | list[str | None]", + "description": "Return only a specific form type. Default is all quarterly, annual, and current reports. Choices: 1-K, 1-SA, 1-U, 10-D, 10-K, 10-KT, 10-Q, 10-QT, 20-F, 40-F, 6-K, 8-K. Multiple items allowed.", + "default": null, + "optional": true, + "choices": [ + "1-K", + "1-SA", + "1-U", + "10-D", + "10-K", + "10-KT", + "10-Q", + "10-QT", + "20-F", + "40-F", + "6-K", + "8-K" + ], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/report_types", + "multiSelect": false + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecLatestFinancialReports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "date | None", + "description": "Report for the period ending.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sic", + "type": "str | None", + "description": "Standard Industrial Classification code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "Type of filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "URL to the filing page.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "url", + "type": "str", + "description": "URL to the filing page.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Document", + "pinned": "left", + "cellDataType": "text", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "url" + } + } + } + } + }, + { + "name": "items", + "type": "str | None", + "description": "Item codes associated with the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "index_headers", + "type": "str", + "description": "URL to the index headers file.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "complete_submission", + "type": "str", + "description": "URL to the complete submission text file.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "metadata", + "type": "str | None", + "description": "URL to the MetaLinks.json file, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_report", + "type": "str | None", + "description": "URL to the Financial_Report.xlsx file, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecLatestFinancialReports", + "openapi_extra": { + "model": "SecLatestFinancialReports" + } + }, + "/sec/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data about trading by a company's management team and board of directors.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.insider_trading(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Wide date ranges can result in long download times. Recommended to use a smaller date range, default is 120 days ago.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Default is today.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecInsiderTrading", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_cik", + "type": "str | None", + "description": "CIK number of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | datetime | None", + "description": "Filing date of the trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_date", + "type": "date | None", + "description": "Date of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_cik", + "type": "int | str | None", + "description": "Reporting individual's CIK.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_name", + "type": "str | None", + "description": "Name of the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_title", + "type": "str | None", + "description": "The title held by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ownership_type", + "type": "str | None", + "description": "Type of ownership, e.g., direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type", + "type": "str | None", + "description": "Type of transaction being reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acquisition_or_disposition", + "type": "str | None", + "description": "Acquisition or disposition of the shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The type of security transacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_owned", + "type": "float | None", + "description": "Number of securities owned by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_transacted", + "type": "float | None", + "description": "Number of securities transacted by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_price", + "type": "float | None", + "description": "The price of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_url", + "type": "str | None", + "description": "Link to the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "ownership_type", + "type": "str | None", + "description": "Type of ownership, direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "form", + "type": "int | str | None", + "description": "Form type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "director", + "type": "bool | None", + "description": "Whether the owner is a director.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "officer", + "type": "bool | None", + "description": "Whether the owner is an officer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ten_percent_owner", + "type": "bool | None", + "description": "Whether the owner is a 10% owner.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other", + "type": "bool | None", + "description": "Whether the owner is classified as other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_text", + "type": "str | None", + "description": "Text for other classification.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_timeliness", + "type": "str | None", + "description": "Timeliness of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nature_of_ownership", + "type": "str | None", + "description": "Nature of the ownership.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exercise_date", + "type": "date | None", + "description": "Date of exercise.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration_date", + "type": "date | None", + "description": "Date of expiration for the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deemed_execution_date", + "type": "date | None", + "description": "Deemed execution date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_security_title", + "type": "str | None", + "description": "Title of the underlying security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_security_shares", + "type": "float | None", + "description": "Number of underlying shares associated with the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_security_value", + "type": "float | None", + "description": "Value of the underlying security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "conversion_exercise_price", + "type": "float | None", + "description": "Price of conversion or exercise of the securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_value", + "type": "float | None", + "description": "Total value of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value_owned", + "type": "float | None", + "description": "Value of the securities owned after the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "footnote", + "type": "str | None", + "description": "Footnote for the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecInsiderTrading", + "openapi_extra": { + "model": "SecInsiderTrading" + } + }, + "/sec/form_13f": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly\nreport that is required to be filed by all institutional investment\nmanagers with at least $100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last\nday of the calendar quarter. Most funds wait until the end of this\nperiod in order to conceal their investment strategy from competitors\nand the public.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.sec.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "x-widget_config": { + "label": "13F Filer", + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/13f_filers", + "style": { + "popupWidth": 600 + }, + "description": "Pick a 13F filer - an institutional investment manager or a company - by name." + } + } + } + }, + { + "name": "date", + "type": "date | None", + "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "x-widget_config": { + "label": "Filing Period", + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/13f_periods", + "optionsParams": { + "symbol": "$symbol" + } + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecForm13FHR", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end-of-quarter date of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str", + "description": "The name of the issuer.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str", + "description": "The CUSIP of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str", + "description": "The title of the asset class for the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "Whether the principal amount represents the number of shares or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "option_type", + "type": "str | None", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_discretion", + "type": "str | None", + "description": "The investment discretion held by the Manager. Sole, shared-defined (DFN), or shared-other (OTR).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "voting_authority_sole", + "type": "int | None", + "description": "The number of shares for which the Manager exercises sole voting authority.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "voting_authority_shared", + "type": "int | None", + "description": "The number of shares for which the Manager exercises a defined shared voting authority.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "voting_authority_none", + "type": "int | None", + "description": "The number of shares for which the Manager exercises no voting authority.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "principal_amount", + "type": "int", + "description": "The total number of shares of the class of security or the principal amount of such class. Defined by the 'security_type'. Only long positions are reported", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "int", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "weight", + "type": "float", + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "SecForm13FHR", + "openapi_extra": { + "model": "SecForm13FHR" + } + }, + "/sec/equity_ftd": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get reported Fail-to-deliver (FTD) data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.equity_ftd(symbol='AAPL', provider='sec')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of reports to parse, from most recent.\n Approximately 24 reports per year, going back to 2009.", + "default": 24, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "skip_reports", + "type": "int | None", + "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecEquityFtd", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "settlement_date", + "type": "date | None", + "description": "The settlement date of the fail.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the Security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quantity", + "type": "int | None", + "description": "The number of fails on that settlement date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price at the previous closing price from the settlement date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The description of the Security.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "sec": [] + }, + "model": "SecEquityFtd", + "openapi_extra": { + "model": "SecEquityFtd" + } + }, + "/sec/management_discussion_analysis": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Management Discussion & Analysis section from the financial statements for a given company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.management_discussion_analysis(symbol='AAPL', provider='sec')\n# Get the Management Discussion & Analysis section by calendar year and period.\nobb.sec.management_discussion_analysis(symbol='AAPL', calendar_year=2020, calendar_period='Q4', provider='sec')\n# Setting 'include_tables' to True will attempt to extract all tables in valid Markdown.\nobb.sec.management_discussion_analysis(symbol='AAPL', calendar_year=2020, calendar_period='Q4', provider='sec', include_tables=True)\n# Setting 'raw_html' to True will bypass extraction and return the raw HTML file, as is. Use this for custom parsing or to access the entire HTML filing.\nobb.sec.management_discussion_analysis(symbol='AAPL', calendar_year=2020, calendar_period='Q4', provider='sec', raw_html=True)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/companies", + "searchable": true, + "style": { + "popupWidth": 950 + }, + "description": "Pick a company with standardized SEC financials (ranked by market cap)." + } + } + } + }, + { + "name": "calendar_year", + "type": "int | None", + "description": "Calendar year of the report. By default, is the current year. If the calendar period is not provided, but the calendar year is, it will return the annual report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "sec": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/filing_options", + "optionsParams": { + "symbol": "$symbol" + } + } + } + } + }, + { + "name": "calendar_period", + "type": "str | None", + "description": "Calendar period of the report. By default, is the most recent report available for the symbol. If no calendar year and no calendar period are provided, it will return the most recent report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "include_tables", + "type": "bool | None", + "description": "Return tables formatted as markdown in the text. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "When True, the file will be cached for use later. Default is True.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "raw_html", + "type": "bool | None", + "description": "When True, the raw HTML content of the entire filing will be returned. Default is False. Use this option to parse the document manually.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecManagementDiscussionAnalysis", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "calendar_year", + "type": "int", + "description": "The calendar year of the report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "calendar_period", + "type": "int", + "description": "The calendar period of the report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "date | None", + "description": "The end date of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "content", + "type": "str", + "description": "The content of the management discussion and analysis.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "url", + "type": "str", + "description": "The URL of the filing from which the data was extracted.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "SecManagementDiscussionAnalysis", + "openapi_extra": { + "widget_config": { + "type": "markdown", + "data": { + "dataKey": "results.content", + "columnsDefs": [] + }, + "staleTime": 86400000, + "refetchInterval": 86400000, + "source": "SEC" + }, + "model": "SecManagementDiscussionAnalysis" + } + }, + "/sec/nport_disclosure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get SEC NPORT-P disclosure filings for a given ETF or mutual fund (US only).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.nport_disclosure(symbol='XLK', provider='sec', year=2025, quarter=1)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (Fund ticker or CIK)", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "year", + "type": "int | None", + "description": "Reporting year of the filing. Default is the year for the most recent, reported, quarter.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "quarter", + "type": "int | None", + "description": "Reporting quarter of the filing. Default is the most recent, reported, quarter.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "sec": [ + { + "name": "date", + "type": "date | None | str", + "description": "Specific filing period (period end date) to retrieve. Defaults to the most recent filing. Overrides year and quarter.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache for the request.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecNportDisclosure", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "Title of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "The LEI of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "The ISIN of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_id", + "type": "str | None", + "description": "Internal identifier for the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_restricted", + "type": "str | None", + "description": "Whether the holding is restricted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fair_value_level", + "type": "int | None", + "description": "The fair value level of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_cash_collateral", + "type": "str | None", + "description": "Whether the holding is cash collateral.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_non_cash_collateral", + "type": "str | None", + "description": "Whether the holding is non-cash collateral.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_loan_by_fund", + "type": "str | None", + "description": "Whether the holding is loan by fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loan_value", + "type": "float | None", + "description": "The loan value of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_conditional", + "type": "str | None", + "description": "The issuer conditions of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_conditional", + "type": "str | None", + "description": "The asset conditions of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payoff_profile", + "type": "str | None", + "description": "The payoff profile of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_category", + "type": "str | None", + "description": "The asset category of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_category", + "type": "str | None", + "description": "The issuer category of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance", + "type": "float | int | None", + "description": "The balance of the holding, in shares or units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "units", + "type": "float | int | str | None", + "description": "The type of units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "The value of the holding, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "weight", + "type": "float | None", + "description": "The weight of the holding, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "sec": [ + { + "name": "maturity_date", + "type": "date | None", + "description": "The maturity date of the debt security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_kind", + "type": "str | None", + "description": "The type of coupon for the debt security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_type", + "type": "str | None", + "description": "The type of rate for the debt security, floating or fixed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annualized_return", + "type": "float | None", + "description": "The annualized return on the debt security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "is_default", + "type": "str | None", + "description": "If the debt security is defaulted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "in_arrears", + "type": "str | None", + "description": "If the debt security is in arrears.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_paid_kind", + "type": "str | None", + "description": "If the debt security payments are paid in kind.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "derivative_category", + "type": "str | None", + "description": "The derivative category of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "counterparty", + "type": "str | None", + "description": "The counterparty of the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_name", + "type": "str | None", + "description": "The name of the underlying asset associated with the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "option_type", + "type": "str | None", + "description": "The type of option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "derivative_payoff", + "type": "str | None", + "description": "The payoff profile of the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiry_date", + "type": "date | None", + "description": "The expiry or termination date of the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exercise_price", + "type": "float | None", + "description": "The exercise price of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exercise_currency", + "type": "str | None", + "description": "The currency of the option exercise price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_per_contract", + "type": "float | None", + "description": "The number of shares per contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "delta", + "type": "float | str | None", + "description": "The delta of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_type_rec", + "type": "str | None", + "description": "The type of rate for receivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receive_currency", + "type": "str | None", + "description": "The receive currency of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "upfront_receive", + "type": "float | None", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "floating_rate_index_rec", + "type": "str | None", + "description": "The floating rate index for receivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "floating_rate_spread_rec", + "type": "float | None", + "description": "The floating rate spread for reveivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_tenor_rec", + "type": "str | None", + "description": "The rate tenor for receivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_tenor_unit_rec", + "type": "int | str | None", + "description": "The rate tenor unit for receivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reset_date_rec", + "type": "str | None", + "description": "The reset date for receivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reset_date_unit_rec", + "type": "int | str | None", + "description": "The reset date unit for receivable portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_type_pmnt", + "type": "str | None", + "description": "The type of rate for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payment_currency", + "type": "str | None", + "description": "The payment currency of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "upfront_payment", + "type": "float | None", + "description": "The upfront amount received of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "floating_rate_index_pmnt", + "type": "str | None", + "description": "The floating rate index for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "floating_rate_spread_pmnt", + "type": "float | None", + "description": "The floating rate spread for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_tenor_pmnt", + "type": "str | None", + "description": "The rate tenor for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rate_tenor_unit_pmnt", + "type": "int | str | None", + "description": "The rate tenor unit for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reset_date_pmnt", + "type": "str | None", + "description": "The reset date for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reset_date_unit_pmnt", + "type": "int | str | None", + "description": "The reset date unit for payment portion of the swap.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "repo_type", + "type": "str | None", + "description": "The type of repo.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_cleared", + "type": "str | None", + "description": "If the repo is cleared.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_tri_party", + "type": "str | None", + "description": "If the repo is tri party.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "principal_amount", + "type": "float | None", + "description": "The principal amount of the repo.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "principal_currency", + "type": "str | None", + "description": "The currency of the principal amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "collateral_type", + "type": "str | None", + "description": "The collateral type of the repo.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "collateral_amount", + "type": "float | None", + "description": "The collateral amount of the repo.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "collateral_currency", + "type": "str | None", + "description": "The currency of the collateral amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_currency", + "type": "str | None", + "description": "The currency of the exchange rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_rate", + "type": "float | None", + "description": "The exchange rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency_sold", + "type": "str | None", + "description": "The currency sold in a Forward Derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency_amount_sold", + "type": "float | None", + "description": "The amount of currency sold in a Forward Derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency_bought", + "type": "str | None", + "description": "The currency bought in a Forward Derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency_amount_bought", + "type": "float | None", + "description": "The amount of currency bought in a Forward Derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "notional_amount", + "type": "float | None", + "description": "The notional amount of the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "notional_currency", + "type": "str | None", + "description": "The currency of the derivative's notional amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unrealized_gain", + "type": "float | None", + "description": "The unrealized gain or loss on the derivative.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecNportDisclosure", + "openapi_extra": { + "model": "SecNportDisclosure" + } + }, + "/sec/nport_fund_metrics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get fund performance, net assets, and flows from the latest NPORT-P filing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.sec.nport_fund_metrics(symbol='XLK', provider='sec')\n```\n\n", + "parameters": { + "standard": [], + "sec": [ + { + "name": "symbol", + "type": "str", + "description": "Fund ticker symbol (mutual fund or ETF).", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Fund", + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/nport_funds", + "style": { + "popupWidth": 950 + } + } + } + }, + { + "name": "date", + "type": "date | None", + "description": "Specific filing period (period end date). Defaults to the latest.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Filing Period", + "type": "endpoint", + "optionsEndpoint": "/api/v1/sec/nport_periods", + "optionsParams": { + "symbol": "$symbol" + } + } + } + }, + { + "name": "year", + "type": "int | None", + "description": "Reporting year of the filing. Default is the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + }, + { + "name": "quarter", + "type": "int | None", + "description": "Reporting quarter of the filing. Default is the most recent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "show": false + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether or not to use cache for the request.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SecNportFundMetrics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "sec": [ + { + "name": "period", + "type": "date", + "description": "Month-end date the metrics apply to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fund_name", + "type": "str | None", + "description": "Name of the fund series.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_return", + "type": "float | None", + "description": "Monthly total return of the fund.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "net_assets", + "type": "float | None", + "description": "Net assets of the fund as of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "float | None", + "description": "Total assets of the fund as of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_and_equivalents", + "type": "float | None", + "description": "Cash and cash equivalents not reported elsewhere.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "creation", + "type": "float | None", + "description": "Total subscriptions (creations) during the month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "redemption", + "type": "float | None", + "description": "Total redemptions during the month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_flow", + "type": "float | None", + "description": "Net fund flow (creations minus redemptions).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "realized_gains", + "type": "float | None", + "description": "Net realized gains during the month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unrealized_gains", + "type": "float | None", + "description": "Net unrealized appreciation during the month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seven_day_gross_yield", + "type": "float | None", + "description": "Seven-day gross yield (money market funds).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "weighted_average_maturity", + "type": "float | None", + "description": "Weighted average maturity in days (money market funds).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weighted_average_life", + "type": "float | None", + "description": "Weighted average life in days (money market funds).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SecNportFundMetrics", + "openapi_extra": { + "widget_config": { + "name": "Fund Performance & Flows", + "description": "Monthly total return, net assets, and creation/redemption flows from the fund's most recent NPORT-P filing.", + "refetchInterval": false, + "gridData": { + "w": 40, + "h": 8 + } + }, + "model": "SecNportFundMetrics" + } + }, + "/technical/sma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Simple Moving Average over the trailing window.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# 50-bar SMA on TSLA close.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nsma = obb.technical.sma(data=data, length=50)\nobb.technical.sma(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Window length in bars.", + "default": 50, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset, positive shifts forward.", + "default": 0, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[SmaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sma", + "type": "float", + "description": "Simple moving average of ``target`` over ``length`` bars.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/ema": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Exponential Moving Average with recency-weighted smoothing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.ema(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "EMA period.", + "default": 50, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[EmaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "ema", + "type": "float", + "description": "Exponential moving average of ``target``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/hma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Alan Hull's lag-reduced moving average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.hma(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=4)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "HMA period.", + "default": 50, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[HmaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "hma", + "type": "float", + "description": "Hull moving average \u2014 lag-reduced WMA blend.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/wma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the linearly-Weighted Moving Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.wma(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "WMA period.", + "default": 50, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[WmaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "wma", + "type": "float", + "description": "Linearly-weighted moving average of ``target``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/zlma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Zero-Lag Exponential Moving Average of Ehlers and Way.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.zlma(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "ZLMA period.", + "default": 50, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ZlmaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "zlma", + "type": "float", + "description": "Zero-Lag EMA of ``target`` \u2014 Ehlers/Way de-lagged EMA.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/tema": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Patrick Mulloy's Triple Exponential Moving Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.tema(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=3)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "TEMA period.", + "default": 10, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[TemaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "tema", + "type": "float", + "description": "Triple EMA \u2014 ``3*EMA - 3*EMA(EMA) + EMA(EMA(EMA))``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/dema": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Patrick Mulloy's Double Exponential Moving Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.dema(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=3)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "DEMA period.", + "default": 10, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[DemaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dema", + "type": "float", + "description": "Double EMA \u2014 ``2*EMA - EMA(EMA)``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/kama": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Perry Kaufman's Adaptive Moving Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.kama(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=3)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Efficiency-ratio lookback.", + "default": 10, + "optional": true + }, + { + "name": "fast", + "type": "int", + "description": "Fastest EMA period bound.", + "default": 2, + "optional": true + }, + { + "name": "slow", + "type": "int", + "description": "Slowest EMA period bound.", + "default": 30, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[KamaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kama", + "type": "float", + "description": "Kaufman adaptive moving average of ``target``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/frama": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate John Ehlers' Fractal Adaptive Moving Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.frama(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], window=4)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series with ``high`` and ``low`` columns.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Window length \u2014 must be even.", + "default": 10, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[FramaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "frama", + "type": "float", + "description": "Fractal adaptive moving average \u2014 Ehlers (2005).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/vwma": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Volume Weighted Moving Average.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.vwma(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=3)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series with ``close`` and ``volume``.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "VWMA period.", + "default": 10, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[VwmaData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vwma", + "type": "float", + "description": "Volume weighted moving average of close.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/bbands": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Bollinger Bands around a moving-average centreline.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.bbands(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to smooth and band, by default ``\"close\"``.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Moving-average period.", + "default": 20, + "optional": true + }, + { + "name": "std", + "type": "float", + "description": "Standard-deviation multiplier.", + "default": 2.0, + "optional": true + }, + { + "name": "mamode", + "type": "str", + "description": "Type of moving average for the middle band.", + "default": "sma", + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[BbandsData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lower", + "type": "float", + "description": "Lower band \u2014 middle minus ``std`` deviations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "middle", + "type": "float", + "description": "Center moving average.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "upper", + "type": "float", + "description": "Upper band \u2014 middle plus ``std`` deviations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bandwidth", + "type": "float", + "description": "``(upper - lower) / middle`` \u2014 width relative to the centre.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "percent", + "type": "float", + "description": "``(price - lower) / (upper - lower)`` \u2014 position within the band.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/donchian": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Donchian Channel \u2014 trailing high/low price envelope.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.donchian(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], lower_length=1, upper_length=3)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series with high/low columns.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "lower_length", + "type": "int", + "description": "Lookback for the lower band.", + "default": 20, + "optional": true + }, + { + "name": "upper_length", + "type": "int", + "description": "Lookback for the upper band.", + "default": 20, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset; positive values shift the series forward, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[DonchianData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lower", + "type": "float", + "description": "Trailing min over ``lower_length`` bars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "middle", + "type": "float", + "description": "Midpoint between upper and lower bands.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "upper", + "type": "float", + "description": "Trailing max over ``upper_length`` bars.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/kc": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Keltner Channel \u2014 an ATR-scaled volatility envelope.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.kc(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Centerline MA period.", + "default": 20, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "ATR multiplier for the bands.", + "default": 2.0, + "optional": true + }, + { + "name": "mamode", + "type": "str", + "description": "Centreline moving-average type.", + "default": "ema", + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Output offset in bars, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[KcData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lower", + "type": "float", + "description": "Centerline minus ``scalar * ATR``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "middle", + "type": "float", + "description": "Centreline moving average.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "upper", + "type": "float", + "description": "Centerline plus ``scalar * ATR``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/ichimoku": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Ichimoku Kinko Hyo cloud \u2014 a five-component trend overlay.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.ichimoku(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "conversion", + "type": "int", + "description": "Tenkan-sen lookback.", + "default": 9, + "optional": true + }, + { + "name": "base", + "type": "int", + "description": "Kijun-sen lookback.", + "default": 26, + "optional": true + }, + { + "name": "lagging", + "type": "int", + "description": "Senkou Span B lookback.", + "default": 52, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Forward projection for the cloud.", + "default": 26, + "optional": true + }, + { + "name": "lookahead", + "type": "bool", + "description": "If ``True``, emit the Chikou Span (look-ahead). Off by default to prevent data leakage.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[IchimokuData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "tenkan_sen", + "type": "float", + "description": "Conversion line.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kijun_sen", + "type": "float", + "description": "Base line.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "senkou_a", + "type": "float", + "description": "Leading span A.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "senkou_b", + "type": "float", + "description": "Leading span B.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "chikou_span", + "type": "float", + "description": "Lagging span. Always ``None`` when ``lookahead=False``.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/supertrend": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Supertrend ATR-banded trailing-stop overlay.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.supertrend(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "ATR lookback.", + "default": 7, + "optional": true + }, + { + "name": "multiplier", + "type": "float", + "description": "ATR multiplier for the bands.", + "default": 3.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[SupertrendData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "supertrend", + "type": "float", + "description": "Current trailing-stop value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "direction", + "type": "int", + "description": "``1`` when the trend is up, ``-1`` when down. ``None`` during warm-up.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_band", + "type": "float", + "description": "Long-side band \u2014 populated only when the trend is up.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "short_band", + "type": "float", + "description": "Short-side band \u2014 populated only when the trend is down.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/rsi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Relative Strength Index (RSI), Wilder's momentum oscillator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# RSI(14) on daily TSLA closes.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nrsi = obb.technical.rsi(data=data, length=14)\nobb.technical.rsi(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Target column to apply RSI to.", + "default": "close", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window in bars.", + "default": 14, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "Output scaling. ``100`` produces the conventional 0\u2013100 range.", + "default": 100.0, + "optional": true + }, + { + "name": "drift", + "type": "int", + "description": "Difference period for momentum.", + "default": 1, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RsiData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rsi", + "type": "float", + "description": "RSI value over the trailing ``length`` bars on ``target``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/stoch": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Stochastic Oscillator (%K and %D).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Stochastic oscillator on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nstoch = obb.technical.stoch(data=data)\nobb.technical.stoch(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "fast_k_period", + "type": "int", + "description": "Fast %K lookback.", + "default": 14, + "optional": true + }, + { + "name": "slow_d_period", + "type": "int", + "description": "Slow %D smoothing.", + "default": 3, + "optional": true + }, + { + "name": "slow_k_period", + "type": "int", + "description": "Slow %K smoothing.", + "default": 3, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[StochData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "k", + "type": "float", + "description": "%K \u2014 current close vs. recent range.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "d", + "type": "float", + "description": "%D \u2014 moving average of %K.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/cci": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Commodity Channel Index (CCI), Lambert's mean-reversion oscillator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# CCI(14) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\ncci = obb.technical.cci(data=data, length=14)\nobb.technical.cci(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window in bars.", + "default": 14, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "Mean-deviation scaling factor (Lambert's original constant).", + "default": 0.015, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CciData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cci", + "type": "float", + "description": "CCI value over the trailing ``length`` bars.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/fisher": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Ehlers' Fisher Transform of price with a signal line.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fisher Transform on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nfisher = obb.technical.fisher(data=data, length=14, signal=1)\nobb.technical.fisher(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series (uses high + low).", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Fisher transform window.", + "default": 14, + "optional": true + }, + { + "name": "signal", + "type": "int", + "description": "Lag for the signal line.", + "default": 1, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[FisherData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fisher", + "type": "float", + "description": "Fisher Transform value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "signal", + "type": "float", + "description": "Lagged Fisher signal line.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/cg": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Ehlers' Center of Gravity oscillator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Center of Gravity on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\ncg = obb.technical.cg(data=data, length=14)\nobb.technical.cg(length=2, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series (uses high/low/close median).", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window in bars.", + "default": 14, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CgData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cg", + "type": "float", + "description": "Center of Gravity value.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/williams_r": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Williams %R, a momentum oscillator inverted from fast stochastic %K.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Williams %R on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nwr = obb.technical.williams_r(data=data, length=14)\nobb.technical.williams_r(length=14, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window in bars.", + "default": 14, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[WilliamsRData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "williams_r", + "type": "float", + "description": "Williams %R \u2014 close relative to the trailing high/low range (\u2212100 to 0).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/mfi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Money Flow Index (MFI), a volume-weighted RSI.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# MFI(14) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nmfi = obb.technical.mfi(data=data, length=14)\nobb.technical.mfi(length=14, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLCV price series \u2014 ``volume`` is required.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window in bars.", + "default": 14, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[MfiData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mfi", + "type": "float", + "description": "Money Flow Index \u2014 volume-weighted RSI on typical price (0\u2013100).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/trix": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate TRIX \u2014 the rate of change of a triple-smoothed EMA \u2014 with signal.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# TRIX(30, 9) on daily TSLA closes.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\ntrix = obb.technical.trix(data=data, length=30, signal=9)\nobb.technical.trix(length=5, signal=3, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Target column to apply TRIX to.", + "default": "close", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Triple-EMA window.", + "default": 30, + "optional": true + }, + { + "name": "signal", + "type": "int", + "description": "Signal line EMA length.", + "default": 9, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[TrixData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trix", + "type": "float", + "description": "1-day ROC of a triple-EMA of ``target``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "signal", + "type": "float", + "description": "EMA of TRIX, length ``signal``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/ultimate_oscillator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Larry Williams' Ultimate Oscillator across three timeframes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Ultimate Oscillator on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nuo = obb.technical.ultimate_oscillator(data=data)\nobb.technical.ultimate_oscillator(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "fast", + "type": "int", + "description": "Short-period lookback.", + "default": 7, + "optional": true + }, + { + "name": "medium", + "type": "int", + "description": "Medium-period lookback.", + "default": 14, + "optional": true + }, + { + "name": "slow", + "type": "int", + "description": "Long-period lookback.", + "default": 28, + "optional": true + }, + { + "name": "fast_weight", + "type": "float", + "description": "Weight applied to the fast period.", + "default": 4.0, + "optional": true + }, + { + "name": "medium_weight", + "type": "float", + "description": "Weight applied to the medium period.", + "default": 2.0, + "optional": true + }, + { + "name": "slow_weight", + "type": "float", + "description": "Weight applied to the slow period.", + "default": 1.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[UltimateOscillatorData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "ultimate_oscillator", + "type": "float", + "description": "Weighted blend of buying pressure over three timeframes (0\u2013100).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/awesome_oscillator": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Bill Williams' Awesome Oscillator as a momentum histogram.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Awesome Oscillator on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nao = obb.technical.awesome_oscillator(data=data)\nobb.technical.awesome_oscillator(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series \u2014 uses median of high/low.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "fast", + "type": "int", + "description": "Short SMA window on median price.", + "default": 5, + "optional": true + }, + { + "name": "slow", + "type": "int", + "description": "Long SMA window on median price.", + "default": 34, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AwesomeOscillatorData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "awesome_oscillator", + "type": "float", + "description": "Fast SMA minus slow SMA of median price.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/macd": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Moving Average Convergence Divergence (MACD) oscillator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# MACD(12,26,9) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nmacd = obb.technical.macd(data=data, fast=12, slow=26, signal=9)\n# MACD with short windows for mock data.\nobb.technical.macd(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], fast=2, slow=3, signal=1)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column to compute MACD on.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "fast", + "type": "int", + "description": "Fast EMA window.", + "default": 12, + "optional": true + }, + { + "name": "slow", + "type": "int", + "description": "Slow EMA window.", + "default": 26, + "optional": true + }, + { + "name": "signal", + "type": "int", + "description": "Signal-line EMA window.", + "default": 9, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[MacdData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "macd", + "type": "float", + "description": "MACD line \u2014 fast EMA minus slow EMA.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "signal", + "type": "float", + "description": "Signal line \u2014 EMA of MACD.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "histogram", + "type": "float", + "description": "MACD minus signal.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/adx": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Wilder's Average Directional Index (ADX), a trend-strength gauge.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# ADX(14) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nadx = obb.technical.adx(data=data, length=14)\nobb.technical.adx(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "ADX lookback window.", + "default": 14, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "Output magnification factor.", + "default": 100.0, + "optional": true + }, + { + "name": "drift", + "type": "int", + "description": "Difference period for directional movement.", + "default": 1, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AdxData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adx", + "type": "float", + "description": "Average Directional Index \u2014 trend-strength score.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/di": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Directional Indicators (+DI, -DI) and raw DX from Wilder's system.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# +DI / -DI / DX(14) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\ndi = obb.technical.di(data=data, length=14)\nobb.technical.di(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window for +DI / -DI.", + "default": 14, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "Output magnification factor.", + "default": 100.0, + "optional": true + }, + { + "name": "drift", + "type": "int", + "description": "Difference period for directional movement.", + "default": 1, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[DiData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "plus_di", + "type": "float", + "description": "Positive Directional Indicator (+DI).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "minus_di", + "type": "float", + "description": "Negative Directional Indicator (-DI).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dx", + "type": "float", + "description": "Directional Index \u2014 |+DI - -DI| / (+DI + -DI) * scalar.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/aroon": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Aroon Up, Aroon Down, and Aroon Oscillator series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Aroon(25) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\naroon = obb.technical.aroon(data=data, length=25)\nobb.technical.aroon(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Aroon lookback window.", + "default": 25, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "Output magnification factor.", + "default": 100.0, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AroonData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "aroon_up", + "type": "float", + "description": "Bars since the highest high, scaled.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "aroon_down", + "type": "float", + "description": "Bars since the lowest low, scaled.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "aroon_oscillator", + "type": "float", + "description": "``aroon_up`` minus ``aroon_down``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/choppiness": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Choppiness Index, a trending-vs-sideways regime classifier.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Choppiness(14) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nchop = obb.technical.choppiness(data=data, length=14)\nobb.technical.choppiness(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Choppiness lookback window.", + "default": 14, + "optional": true + }, + { + "name": "atr_length", + "type": "int", + "description": "ATR window used inside choppiness.", + "default": 1, + "optional": true + }, + { + "name": "scalar", + "type": "float", + "description": "Output magnification factor.", + "default": 100.0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ChoppinessData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "choppiness", + "type": "float", + "description": "Choppiness Index \u2014 high values mean sideways action.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/obv": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate On-Balance Volume (OBV), a cumulative volume-flow indicator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# OBV on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nobv = obb.technical.obv(data=data)\nobb.technical.obv(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLCV price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Periods to offset the result.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ObvData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "obv", + "type": "float", + "description": "On-Balance Volume cumulative total.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/ad": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Accumulation/Distribution line, a volume-flow indicator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Accumulation/Distribution line on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nad = obb.technical.ad(data=data)\nobb.technical.ad(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLCV price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Periods to offset the result.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AdData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "ad", + "type": "float", + "description": "Accumulation/Distribution cumulative line.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/adosc": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Chaikin Accumulation/Distribution Oscillator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Chaikin Oscillator on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nadosc = obb.technical.adosc(data=data, fast=3, slow=10)\nobb.technical.adosc(fast=2, slow=4, data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLCV price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "fast", + "type": "int", + "description": "Fast EMA window.", + "default": 3, + "optional": true + }, + { + "name": "slow", + "type": "int", + "description": "Slow EMA window.", + "default": 10, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Periods to offset the result.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AdoscData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adosc", + "type": "float", + "description": "Chaikin Accumulation/Distribution Oscillator.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/vwap": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Volume-Weighted Average Price (VWAP), anchored at a chosen boundary.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily-anchored VWAP on intraday TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nvwap = obb.technical.vwap(data=data, anchor='D')\nobb.technical.vwap(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLCV price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "anchor", + "type": "str", + "description": "Resample anchor \u2014 pandas offset alias such as ``D``, ``W``, ``ME``. Determines the VWAP reset boundary.", + "default": "D", + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Periods to offset the result.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[VwapData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float", + "description": "Volume-weighted average price.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/realized_volatility": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate annualised rolling realised volatility under a chosen estimator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Yang-Zhang realised volatility on daily SPY.\ndata = obb.equity.price.historical(symbol='SPY', start_date='2022-01-01', provider='yfinance').results\nrv = obb.technical.realized_volatility(data=data, model='yang_zhang', window=30)\nobb.technical.realized_volatility(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], model='parkinson')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLC(V) price series.", + "default": null, + "optional": false + }, + { + "name": "model", + "type": "str", + "description": "Volatility estimator. ``yang_zhang`` is the lowest-error blend; ``parkinson`` and ``rogers_satchell`` are range-based and drift-invariant; ``hodges_tompkins`` is bias-corrected close-to-close.", + "default": "yang_zhang", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Rolling window length in bars.", + "default": 30, + "optional": true + }, + { + "name": "trading_periods", + "type": "int", + "description": "Annualisation factor. ``None`` resolves to 365 when ``is_crypto`` is true, otherwise 252.", + "default": null, + "optional": true + }, + { + "name": "is_crypto", + "type": "bool", + "description": "When true and ``trading_periods`` is unset, annualise over 365 instead of 252.", + "default": false, + "optional": true + }, + { + "name": "clean", + "type": "bool", + "description": "Drop the leading warm-up rows where the rolling window is incomplete.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RealizedVolatilityData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volatility", + "type": "float", + "description": "Annualised realised volatility per the chosen ``model`` over the trailing ``window`` bars. ``None`` during warm-up when ``clean=False``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "model", + "type": "str", + "description": "Echoed on every row so the response is self-describing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "window", + "type": "int", + "description": "Window used to produce this row.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trading_periods", + "type": "int", + "description": "Annualisation factor used to produce this row.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/realized_volatility_compare": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute realised volatility under every requested estimator, side by side.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.realized_volatility_compare(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLC price series \u2014 every column required.", + "default": null, + "optional": false + }, + { + "name": "models", + "type": "list[Literal['std', 'parkinson', 'garman_klass', 'hodges_tompkins', 'rogers_satchell', 'yang_zhang']]", + "description": "Estimators to compute. Defaults to all six.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Rolling window length in bars, by default 30.", + "default": 30, + "optional": true + }, + { + "name": "trading_periods", + "type": "int", + "description": "Annualisation factor. When unset, resolves to 365 if ``is_crypto`` is ``True``, otherwise 252.", + "default": null, + "optional": true + }, + { + "name": "is_crypto", + "type": "bool", + "description": "When ``True`` and ``trading_periods`` is unset, annualise over 365 instead of 252, by default ``False``.", + "default": false, + "optional": true + }, + { + "name": "clean", + "type": "bool", + "description": "Drop rows where ANY requested model has not yet warmed up.", + "default": true, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RealizedVolatilityCompareData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "std", + "type": "float", + "description": "Close-to-close standard-deviation volatility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parkinson", + "type": "float", + "description": "Parkinson range-based volatility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "garman_klass", + "type": "float", + "description": "Garman-Klass OHLC volatility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hodges_tompkins", + "type": "float", + "description": "Bias-corrected close-to-close volatility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rogers_satchell", + "type": "float", + "description": "Rogers-Satchell drift-invariant volatility.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "yang_zhang", + "type": "float", + "description": "Yang-Zhang minimum-variance volatility.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/cones": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Build a volatility-cone snapshot summarising realised volatility by window.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get volatility cones for the past two years of SPY.\ndata = obb.equity.price.historical(symbol='SPY', start_date='2022-01-01', provider='yfinance').results\ncones = obb.technical.cones(data=data, model='yang_zhang')\nobb.technical.cones(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "lower_q", + "type": "float", + "description": "Lower quantile for the cone band (0\u20131, exclusive of 1).", + "default": 0.25, + "optional": true + }, + { + "name": "upper_q", + "type": "float", + "description": "Upper quantile for the cone band (0\u20131, exclusive of 1).", + "default": 0.75, + "optional": true + }, + { + "name": "model", + "type": "str", + "description": "Estimator applied to each rolling window, by default ``\"std\"``.", + "default": "std", + "optional": true + }, + { + "name": "is_crypto", + "type": "bool", + "description": "When ``True`` and ``trading_periods`` is unset, annualise over 365 instead of 252, by default ``False``.", + "default": false, + "optional": true + }, + { + "name": "trading_periods", + "type": "int", + "description": "Annualisation factor. When unset, resolves to 365 if ``is_crypto`` is ``True``, otherwise 252.", + "default": null, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ConesData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "window", + "type": "int", + "description": "Rolling window length in bars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "realized", + "type": "float", + "description": "Most-recent annualised volatility.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "min", + "type": "float", + "description": "Historical minimum of annualised volatility at this window.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "lower", + "type": "float", + "description": "Lower-quantile cone band.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "median", + "type": "float", + "description": "Historical median of annualised volatility at this window.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "upper", + "type": "float", + "description": "Upper-quantile cone band.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max", + "type": "float", + "description": "Historical maximum of annualised volatility at this window.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/atr": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate the Average True Range (ATR), Wilder's volatility measure.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# ATR(14) on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\natr = obb.technical.atr(data=data, length=14)\nobb.technical.atr(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], length=14)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "ATR lookback window.", + "default": 14, + "optional": true + }, + { + "name": "mamode", + "type": "str", + "description": "Smoothing applied to true-range. ``rma`` is the Wilder default.", + "default": "rma", + "optional": true + }, + { + "name": "drift", + "type": "int", + "description": "Difference period for true-range.", + "default": 1, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Shift the output series by this many bars, by default 0.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AtrData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "atr", + "type": "float", + "description": "Average true range over the trailing ``length`` bars.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/fib": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute Fibonacci retracement levels between a swing high and swing low.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fibonacci retracement on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\nfib = obb.technical.fib(data=data, period=120)\nobb.technical.fib(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC(V) price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "close_column", + "type": "str", + "description": "Column used for high/low detection.", + "default": "close", + "optional": true + }, + { + "name": "period", + "type": "int", + "description": "Lookback in bars for retracement.", + "default": 120, + "optional": true + }, + { + "name": "start_date", + "type": "str", + "description": "Explicit retracement start date.", + "default": null, + "optional": true + }, + { + "name": "end_date", + "type": "str", + "description": "Explicit retracement end date.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[FibData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "level", + "type": "str", + "description": "Retracement percentage label, e.g. ``38.2%``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "Price at the retracement level.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/demark": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute Tom DeMark sequential up- and down-count exhaustion indicators.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# DeMark sequential on daily TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\ndemark = obb.technical.demark(data=data)\nobb.technical.demark(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to evaluate.", + "default": "close", + "optional": true + }, + { + "name": "show_all", + "type": "bool", + "description": "When True show counts 1-13; False shows only 6-9.", + "default": true, + "optional": true + }, + { + "name": "asint", + "type": "bool", + "description": "Cast counts to integers and fill NaN with 0.", + "default": true, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Periods to offset the result.", + "default": 0, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[DemarkData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "up", + "type": "float | int", + "description": "Upward sequential count.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "down", + "type": "float | int", + "description": "Downward sequential count.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/pivot_points": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute pivot-point support and resistance bands under multiple methods.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Classic daily pivot points on TSLA.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='fmp').results\npivots = obb.technical.pivot_points(data=data, method='classic', anchor='day')\nobb.technical.pivot_points(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``, by default ``\"date\"``.", + "default": "date", + "optional": true + }, + { + "name": "method", + "type": "str", + "description": "Pivot-point family. ``camarilla`` is the only one that fills r4/s4.", + "default": "classic", + "optional": true + }, + { + "name": "anchor", + "type": "str", + "description": "Resample anchor for the pivot calculation.", + "default": "day", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PivotPointsData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Period start date of the resampled pivot.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pivot", + "type": "float", + "description": "Central pivot price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "r1", + "type": "float", + "description": "First resistance band above the pivot.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "r2", + "type": "float", + "description": "Second resistance band above the pivot.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "r3", + "type": "float", + "description": "Third resistance band above the pivot.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "r4", + "type": "float", + "description": "Only populated for camarilla.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "s1", + "type": "float", + "description": "First support band below the pivot.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "s2", + "type": "float", + "description": "Second support band below the pivot.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "s3", + "type": "float", + "description": "Third support band below the pivot.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "s4", + "type": "float", + "description": "Only populated for camarilla.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/clenow": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate Clenow Volatility-Adjusted Momentum on log prices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Clenow momentum on TSLA over the trailing 90 days.\ndata = obb.equity.price.historical(symbol='TSLA', start_date='2023-01-01', provider='yfinance').results\nout = obb.technical.clenow(data=data, period=90)\nobb.technical.clenow(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], period=2)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to regress.", + "default": "close", + "optional": true + }, + { + "name": "period", + "type": "int", + "description": "Lookback window for the log-price regression.", + "default": 90, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ClenowData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "predicted", + "type": "float", + "description": "Best-fit log-linear value at this date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "r2", + "type": "float", + "description": "R-squared of the regression fit on log prices.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "coefficient", + "type": "float", + "description": "Annualised slope of the log-price regression.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "annualized_coefficient", + "type": "float", + "description": "``coefficient * r2`` - Clenow's momentum factor.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/drawdown": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute cumulative return, running peak, drawdown, and underwater duration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.drawdown(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to evaluate drawdowns on.", + "default": "close", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[DrawdownData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cumulative_return", + "type": "float", + "description": "Cumulative return from the first observation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "running_peak", + "type": "float", + "description": "Running maximum of ``cumulative_return``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "drawdown", + "type": "float", + "description": "Percentage drop from the running peak (negative or zero).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "drawdown_duration_days", + "type": "int", + "description": "Consecutive observations since the most recent peak.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/returns_stats": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Calculate distributional and risk-adjusted statistics on simple returns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.returns_stats(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to evaluate returns on.", + "default": "close", + "optional": true + }, + { + "name": "frequency", + "type": "str", + "description": "Annualisation frequency for Sharpe/Sortino/Calmar/risk-free.", + "default": "daily", + "optional": true + }, + { + "name": "risk_free_rate", + "type": "float", + "description": "Annualised risk-free rate used for Sharpe and Sortino.", + "default": 0.0, + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Rolling window. ``None`` returns a single summary row.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ReturnsStatsData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Window end date, or ``None`` for the summary row.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mean_return", + "type": "float", + "description": "Arithmetic mean of simple returns over the window.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "std_return", + "type": "float", + "description": "Sample standard deviation of returns (ddof=1).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "skew", + "type": "float", + "description": "Skewness of the return distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kurtosis", + "type": "float", + "description": "Excess kurtosis of the return distribution.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sharpe", + "type": "float", + "description": "Annualised Sharpe ratio of excess returns.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "sortino", + "type": "float", + "description": "Annualised Sortino ratio using downside deviation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "calmar", + "type": "float", + "description": "Annualised return divided by the absolute value of max drawdown.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "max_drawdown", + "type": "float", + "description": "Worst peak-to-trough drawdown over the window (negative).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "var_95", + "type": "float", + "description": "5th-percentile return - historical Value-at-Risk at 95%.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cvar_95", + "type": "float", + "description": "Mean of returns at or below ``var_95`` - historical Conditional VaR.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/stationarity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Test a series for stationarity using ADF, KPSS, or both with a combined verdict.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.stationarity(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to test for stationarity.", + "default": "close", + "optional": true + }, + { + "name": "test", + "type": "str", + "description": "Which test(s) to run.", + "default": "both", + "optional": true + }, + { + "name": "regression", + "type": "str", + "description": "Regression component: constant, trend, quadratic-trend, or none.", + "default": "c", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[StationarityData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "adf_statistic", + "type": "float", + "description": "Augmented Dickey-Fuller test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_pvalue", + "type": "float", + "description": "ADF p-value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_critical_1pct", + "type": "float", + "description": "ADF critical value at the 1% significance level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_critical_5pct", + "type": "float", + "description": "ADF critical value at the 5% significance level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_critical_10pct", + "type": "float", + "description": "ADF critical value at the 10% significance level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adf_verdict", + "type": "str", + "description": "ADF verdict at 5%, or ``\"skipped\"`` when the test was not run.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_statistic", + "type": "float", + "description": "Kwiatkowski-Phillips-Schmidt-Shin test statistic.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_pvalue", + "type": "float", + "description": "KPSS p-value.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_critical_1pct", + "type": "float", + "description": "KPSS critical value at the 1% significance level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_critical_5pct", + "type": "float", + "description": "KPSS critical value at the 5% significance level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_critical_10pct", + "type": "float", + "description": "KPSS critical value at the 10% significance level.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kpss_verdict", + "type": "str", + "description": "KPSS verdict at 5%, or ``\"skipped\"`` when the test was not run.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "overall_verdict", + "type": "str", + "description": "Combined verdict from the available ADF and KPSS results.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/hurst": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Estimate the Hurst exponent via Rescaled-Range analysis or DFA.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.hurst(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to evaluate.", + "default": "close", + "optional": true + }, + { + "name": "method", + "type": "str", + "description": "``rs`` = Rescaled Range; ``dfa`` = Detrended Fluctuation.", + "default": "rs", + "optional": true + }, + { + "name": "min_lag", + "type": "int", + "description": "Smallest window length.", + "default": 2, + "optional": true + }, + { + "name": "max_lag", + "type": "int", + "description": "Largest window length (exclusive).", + "default": 100, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[HurstData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "hurst_exponent", + "type": "float", + "description": "Estimated Hurst exponent in ``[0, 1]``. ``None`` when the fit could not be computed.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "interpretation", + "type": "str", + "description": "Qualitative classification: ``trending`` for H > 0.55, ``mean_reverting`` for H < 0.45, otherwise ``random_walk``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "confidence", + "type": "float", + "description": "R-squared of the log-log fit used to estimate the exponent.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/autocorrelation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute autocorrelation (ACF) and partial autocorrelation (PACF) with bands.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.autocorrelation(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to evaluate.", + "default": "close", + "optional": true + }, + { + "name": "use_returns", + "type": "bool", + "description": "Difference and percent-change before computing.", + "default": true, + "optional": true + }, + { + "name": "max_lag", + "type": "int", + "description": "Largest lag to compute.", + "default": 40, + "optional": true + }, + { + "name": "method", + "type": "str", + "description": "Which functions to compute.", + "default": "both", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[AutocorrelationData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "lag", + "type": "int", + "description": "Lag in bars (0 is the series with itself, by definition 1.0 for ACF).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "acf", + "type": "float", + "description": "Sample autocorrelation at this lag, or ``None`` when ACF was skipped.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pacf", + "type": "float", + "description": "Sample partial autocorrelation at this lag, or ``None`` when PACF was skipped.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "acf_confidence_lower", + "type": "float", + "description": "Lower bound of the 95% confidence band for the ACF estimate.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "acf_confidence_upper", + "type": "float", + "description": "Upper bound of the 95% confidence band for the ACF estimate.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "significant", + "type": "bool", + "description": "``True`` when the ACF estimate at this lag (other than lag 0) lies outside the 95% confidence band.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/relative_rotation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute the Relative Rotation Graph (RRG) for a basket against a benchmark.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Relative Strength Ratio and Momentum for a basket of symbols against a benchmark.\ndata = obb.equity.price.historical(symbol='AAPL,MSFT,GOOGL,META,AMZN,TSLA,SPY', start_date='2022-01-01', provider='yfinance').results\nrr = obb.technical.relative_rotation(data=data, benchmark='SPY')\nobb.technical.relative_rotation(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], benchmark='SPY')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "The data to be used for the relative rotation calculations. This should be the multi-symbol output from the 'equity.price.historical' endpoint, or similar, at a daily interval. Or a pivot table with the 'date' column as the index, the symbols as the columns, and the 'study' as the values. It is recommended to use the 'equity.price.historical' endpoint to get the data, and feed the results as-is.", + "default": null, + "optional": false + }, + { + "name": "benchmark", + "type": "str", + "description": "The symbol to be used as the benchmark.", + "default": null, + "optional": false + }, + { + "name": "study", + "type": "str", + "description": "The data point for the calculations. If 'price', the closing price will be used. If 'volatility', the standard deviation of the closing price will be used. If 'data' is supplied as a pivot table, the 'study' will assume the values are the closing price and 'volume' will be ignored.", + "default": "price", + "optional": true + }, + { + "name": "long_period", + "type": "int", + "description": "The length of the long period for momentum calculation, by default is 252. Adjust this value, to 365, when supplying assets such as crypto.", + "default": 252, + "optional": true + }, + { + "name": "short_period", + "type": "int", + "description": "The length of the short period for momentum calculation, by default is 21. Adjust this value, to 30, when supplying assets such as crypto.", + "default": 21, + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "The length of window for the standard deviation calculation, by default is 21. Adjust this value, to 30, when supplying assets such as crypto.", + "default": 21, + "optional": true + }, + { + "name": "trading_periods", + "type": "int", + "description": "The number of trading periods per year, for the standard deviation calculation, by default is 252. Adjust this value, to 365, when supplying assets such as crypto.", + "default": 252, + "optional": true + }, + { + "name": "chart_params", + "type": "dict[str, Any]", + "description": "Additional parameters to pass when `chart=True` and the `openbb-charting` extension is installed. Parameters can be passed again to redraw the chart using the charting.to_chart() method of the response.\n\n ChartParams\n -----------\n date: Optional[str]\n A target end date within the data, by default is the last date in the data.\n show_tails: bool\n Show the tails on the chart, by default is True.\n tail_periods: Optional[int]\n Number of periods to show in the tails, by default is 16.\n tail_interval: Literal['day', 'week', 'month']\n Interval to show the tails, by default is 'week'.\n title: Optional[str]\n Title of the chart.", + "default": null, + "optional": true + }, + { + "name": "chart", + "type": "bool", + "description": "Whether to create a chart or not, by default False.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "RelativeRotationData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbols", + "type": "list[str]", + "description": "The symbols that are being compared against the benchmark.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "benchmark", + "type": "str", + "description": "The benchmark symbol, as entered by the user.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "study", + "type": "str", + "description": "The data point for the study, as entered by the user.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "long_period", + "type": "int", + "description": "The length of the long period for momentum calculation, as entered by the user.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "short_period", + "type": "int", + "description": "The length of the short period for momentum calculation, as entered by the user.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "window", + "type": "int", + "description": "The length of window for the standard deviation calculation, as entered by the user.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "trading_periods", + "type": "int", + "description": "The number of trading periods per year, for the standard deviation calculation, as entered by the user.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "str", + "description": "The start date of the data after adjusting the length of the data for the calculations.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "str", + "description": "The end date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbols_data", + "type": "list[Data]", + "description": "The data representing the selected 'study' for each symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "benchmark_data", + "type": "list[Data]", + "description": "The data representing the selected 'study' for the benchmark.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rs_ratios", + "type": "list[Data]", + "description": "The normalized relative strength ratios data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rs_momentum", + "type": "list[Data]", + "description": "The normalized relative strength momentum data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/signals/crossovers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Detect bullish and bearish moving-average crossover events.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# 20/50 SMA crossover events on daily SPY.\ndata = obb.equity.price.historical(symbol='SPY', start_date='2022-01-01', provider='yfinance').results\nevents = obb.technical.crossovers(data=data, fast_length=20, slow_length=50)\nobb.technical.signals.crossovers(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input price series.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Column on which to compute moving averages.", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "fast_length", + "type": "int", + "description": "Lookback for the fast moving average.", + "default": 20, + "optional": true + }, + { + "name": "slow_length", + "type": "int", + "description": "Lookback for the slow moving average.", + "default": 50, + "optional": true + }, + { + "name": "mamode", + "type": "str", + "description": "Moving-average flavour. ``sma`` is the default; ``ema``, ``wma``, ``hma`` and ``zlma`` are also supported.", + "default": "sma", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CrossoverEvent]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Date of the crossover bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "direction", + "type": "str", + "description": "``bullish`` when fast crosses above slow, ``bearish`` when fast crosses below.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fast_value", + "type": "float", + "description": "Fast moving-average value at the crossover bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "slow_value", + "type": "float", + "description": "Slow moving-average value at the crossover bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "Target-column price at the crossover bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "distance", + "type": "float", + "description": "``fast_value - slow_value``. Positive for bullish, negative for bearish crossovers.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/signals/oscillator_signals": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Label every bar with its oscillator regime and emit crossing events.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.signals.oscillator_signals(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], indicator='rsi', length=14)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLC(V) price series.", + "default": null, + "optional": false + }, + { + "name": "indicator", + "type": "str", + "description": "Which oscillator to evaluate against its threshold bands.", + "default": null, + "optional": false + }, + { + "name": "target", + "type": "str", + "description": "Price column used for oscillators that take a single series (rsi, cci).", + "default": "close", + "optional": true + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window for the oscillator.", + "default": 14, + "optional": true + }, + { + "name": "overbought_threshold", + "type": "float", + "description": "Upper band. ``None`` resolves to the indicator default (rsi 70, mfi 80, stoch 80, williams_r -20, cci 100).", + "default": null, + "optional": true + }, + { + "name": "oversold_threshold", + "type": "float", + "description": "Lower band. ``None`` resolves to the indicator default (rsi 30, mfi 20, stoch 20, williams_r -80, cci -100).", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[OscillatorSignal]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float", + "description": "Oscillator value on this bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "regime", + "type": "str", + "description": "Region of the oscillator on this bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "crossed_into_overbought", + "type": "bool", + "description": "True on the bar the regime first becomes overbought.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "crossed_into_oversold", + "type": "bool", + "description": "True on the bar the regime first becomes oversold.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "crossed_out_of_overbought", + "type": "bool", + "description": "True on the bar the regime leaves overbought (to neutral or oversold).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "crossed_out_of_oversold", + "type": "bool", + "description": "True on the bar the regime leaves oversold (to neutral or overbought).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/signals/divergences": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Detect regular and hidden divergences between price swings and an oscillator.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# RSI divergences on daily SPY.\ndata = obb.equity.price.historical(symbol='SPY', start_date='2022-01-01', provider='yfinance').results\nevents = obb.technical.divergences(data=data, indicator='rsi')\nobb.technical.signals.divergences(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], indicator='rsi')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "indicator", + "type": "str", + "description": "Oscillator paired with price for divergence detection.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "indicator_length", + "type": "int", + "description": "Lookback length used inside the oscillator.", + "default": 14, + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Price column used for swings.", + "default": "close", + "optional": true + }, + { + "name": "lookback", + "type": "int", + "description": "Number of recent bars in which to search for swing pairs.", + "default": 60, + "optional": true + }, + { + "name": "min_swing_distance", + "type": "int", + "description": "Minimum number of bars separating two swing points. Also doubles as the half-window for local-extreme detection.", + "default": 5, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[DivergenceEvent]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "confirmation_date", + "type": "date | datetime | str", + "description": "Bar of the later (confirming) swing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "prior_swing_date", + "type": "date | datetime | str", + "description": "Bar of the earlier swing in the pair.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "kind", + "type": "str", + "description": "``regular_bullish`` / ``regular_bearish`` flag reversal signals; ``hidden_*`` flag trend-continuation signals.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price_at_prior", + "type": "float", + "description": "Target-column price at ``prior_swing_date``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price_at_confirmation", + "type": "float", + "description": "Target-column price at ``confirmation_date``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "indicator_at_prior", + "type": "float", + "description": "Oscillator value at ``prior_swing_date``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "indicator_at_confirmation", + "type": "float", + "description": "Oscillator value at ``confirmation_date``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "strength", + "type": "float", + "description": "0-1 score combining the relative price and indicator displacements. Higher means a wider, more emphatic divergence.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/signals/breakouts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Detect channel breakouts where price closes beyond a rolling envelope.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.technical.signals.breakouts(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], method='donchian', length=20)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "method", + "type": "str", + "description": "Channel definition: Donchian (rolling high/low) or Bollinger (mean +/- ``band_std`` * stdev).", + "default": "donchian", + "optional": true + }, + { + "name": "length", + "type": "int", + "description": "Lookback window for the channel.", + "default": 20, + "optional": true + }, + { + "name": "band_std", + "type": "float", + "description": "Bollinger band multiplier. Ignored for ``donchian``. ``None`` resolves to 2.0 when ``method='bollinger'``.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[BreakoutEvent]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Bar on which the breakout occurred.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "direction", + "type": "str", + "description": "Which band was crossed.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "Close price on the breakout bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "band", + "type": "float", + "description": "Previous bar's band level that was breached.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "magnitude", + "type": "float", + "description": "Signed distance: ``price - band``. Positive for upside, negative for downside.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bars_in_range", + "type": "int", + "description": "Bars since the most recent breakout (in either direction).", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/signals/candlestick_patterns": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Scan OHLC bars for classical candlestick patterns and emit one row per match.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Scan all supported patterns on daily SPY.\ndata = obb.equity.price.historical(symbol='SPY', start_date='2022-01-01', provider='yfinance').results\npatterns = obb.technical.candlestick_patterns(data=data)\nobb.technical.signals.candlestick_patterns(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "patterns", + "type": "list[str]", + "description": "Subset of patterns to scan for. ``None`` runs every entry in ``SUPPORTED_PATTERNS``.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[PatternEvent]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Date of the pattern bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pattern", + "type": "str", + "description": "Pattern name, lower-snake-case.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "direction", + "type": "str", + "description": "Bias implied by the pattern: ``bullish``, ``bearish`` or ``neutral``.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "confidence", + "type": "float", + "description": "Heuristic 0-1 score derived from body/shadow ratios. Higher means the bar matches the textbook pattern more cleanly.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/signals/regime": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Label each bar with a market regime from ADX and Choppiness Index pairs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily regime labelling on SPY.\ndata = obb.equity.price.historical(symbol='SPY', start_date='2022-01-01', provider='yfinance').results\nregime = obb.technical.regime(data=data)\nobb.technical.signals.regime(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "OHLC price series.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "adx_length", + "type": "int", + "description": "ADX lookback window.", + "default": 14, + "optional": true + }, + { + "name": "choppiness_length", + "type": "int", + "description": "Choppiness Index lookback window.", + "default": 14, + "optional": true + }, + { + "name": "adx_trend_threshold", + "type": "float", + "description": "ADX above this threshold marks a trending bar. Half this value is the cutoff for a weak trend.", + "default": 25.0, + "optional": true + }, + { + "name": "choppiness_range_threshold", + "type": "float", + "description": "Choppiness above this threshold marks a ranging bar. The default 61.8 is a common Fibonacci-derived cutoff.", + "default": 61.8, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[RegimeData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "adx", + "type": "float", + "description": "ADX reading at this bar. ``None`` during warm-up.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "choppiness", + "type": "float", + "description": "Choppiness Index reading at this bar. ``None`` during warm-up.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "regime", + "type": "str", + "description": "Classified regime for this bar.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "regime_changed", + "type": "bool", + "description": "``True`` when this bar's regime differs from the previous bar's.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/multi": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Run multiple indicators on a single price series and merge them by date.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Input OHLC(V) series.", + "default": null, + "optional": false + }, + { + "name": "indicators", + "type": "list[MultiIndicatorRequest]", + "description": "Indicators to compute, in arbitrary order.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Target column forwarded to indicators that accept one.", + "default": "close", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[MultiResultRow]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "values", + "type": "dict[str, float]", + "description": "Indicator outputs for this date keyed as ``\".\"``. Numeric columns only \u2014 non-numeric outputs are skipped.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/correlation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute rolling pairwise correlation of returns across symbols.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Long-format multi-symbol price data with a ``symbol`` column.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to compute correlation on.", + "default": "close", + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "Rolling window length in bars.", + "default": 60, + "optional": true + }, + { + "name": "method", + "type": "str", + "description": "Correlation method passed through to ``pandas.DataFrame.corr``.", + "default": "pearson", + "optional": true + }, + { + "name": "pairs", + "type": "list[tuple[str, str]]", + "description": "Optional explicit list of ``(symbol_a, symbol_b)`` pairs. Defaults to all unique pairs.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CorrelationData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "Observation date.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol_a", + "type": "str", + "description": "First symbol of the pair.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol_b", + "type": "str", + "description": "Second symbol of the pair.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "correlation", + "type": "float", + "description": "Rolling correlation between ``symbol_a`` and ``symbol_b``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/correlation_matrix": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Build a point-in-time correlation matrix across every symbol in the input.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Long-format multi-symbol price data with a ``symbol`` column.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Column to correlate.", + "default": "close", + "optional": true + }, + { + "name": "window", + "type": "int", + "description": "If set, restrict correlation to the trailing ``window`` rows before ``as_of_date``. ``None`` uses every available row.", + "default": null, + "optional": true + }, + { + "name": "method", + "type": "str", + "description": "Correlation method, by default ``\"pearson\"``.", + "default": "pearson", + "optional": true + }, + { + "name": "as_of_date", + "type": "date | datetime | str", + "description": "Anchor date for the snapshot. ``None`` uses the last available row in the input.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[CorrelationMatrixData]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "as_of_date", + "type": "date | datetime | str", + "description": "Anchor date used for the snapshot.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbols", + "type": "list[str]", + "description": "Symbols, in matrix order.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "matrix", + "type": "list[list[float]]", + "description": "Correlation values.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/screen": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Filter a multi-symbol basket by indicator-driven conditions.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "data", + "type": "Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray", + "description": "Long-format multi-symbol data with a ``symbol`` column.", + "default": null, + "optional": false + }, + { + "name": "conditions", + "type": "list[ScreenCondition]", + "description": "Predicates to evaluate against each symbol's indicators.", + "default": null, + "optional": false + }, + { + "name": "index", + "type": "str", + "description": "Index column name in ``data``.", + "default": "date", + "optional": true + }, + { + "name": "target", + "type": "str", + "description": "Default target column.", + "default": "close", + "optional": true + }, + { + "name": "combine", + "type": "str", + "description": "``and`` returns symbols matching every condition; ``or`` returns symbols matching at least one.", + "default": "and", + "optional": true + }, + { + "name": "as_of_date", + "type": "date | datetime | str", + "description": "Anchor date. Defaults to the latest date per symbol when unset.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "list[ScreenMatch]", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol that matched.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "as_of_date", + "type": "date | datetime | str", + "description": "Date used for evaluation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "matched_conditions", + "type": "int", + "description": "How many conditions fired.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "values", + "type": "dict[str, float]", + "description": "Latest indicator values that contributed to the match, keyed by ``\".\"``.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/technical/indicators": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return the catalogue of registered technical indicators.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "category", + "type": "str", + "description": "Filter to a single family, or ``all`` to return everything.", + "default": "all", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "IndicatorsResponse", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "indicators", + "type": "list[IndicatorEntry]", + "description": "Catalogue entries matching the requested category.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/tmx/equity/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the instrument symbology across markets and asset classes.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search every market in the symbology.\nobb.tmx.equity.search(query='bank', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "is_symbol", + "type": "bool | None", + "description": "Whether to search by ticker symbol.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "country", + "type": "str | None", + "description": "Restrict to a two-letter country code. Set to None for every market.", + "default": "CA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Canada", + "value": "CA" + }, + { + "label": "United States", + "value": "US" + }, + { + "label": "United Kingdom", + "value": "GB" + } + ] + } + } + }, + { + "name": "symbol_only", + "type": "bool | None", + "description": "Match the symbol only, instead of the symbol or the name.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of results.", + "default": 200, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEquitySearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the instrument trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_code", + "type": "str | None", + "description": "The exchange code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country the instrument is listed in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The instrument type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market capitalization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "optionable", + "type": "bool | None", + "description": "Whether the instrument has listed options.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEquitySearch", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "description": "The symbol a click on the search results selects.", + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "TmxEquitySearch" + } + }, + "/tmx/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen the listed universe by venue, instrument type, and size.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Screen the listed universe by venue, type, and size.\nobb.tmx.equity.screener(exchange='TSX', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "exchange", + "type": "str | None", + "description": "Restrict to one listing venue.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Toronto Stock Exchange", + "value": "TSX" + }, + { + "label": "TSX Venture Exchange", + "value": "TSXV" + }, + { + "label": "Canadian Securities Exchange", + "value": "CSE" + }, + { + "label": "Alpha Exchange", + "value": "ALPHA" + }, + { + "label": "NEO Lit", + "value": "NEO-L" + }, + { + "label": "NEO Dark", + "value": "NEO-D" + }, + { + "label": "NEO NASDAQ", + "value": "NEO-N" + }, + { + "label": "Canadian Mutual Funds", + "value": "CMF" + }, + { + "label": "Montreal Exchange", + "value": "MOE" + } + ] + } + } + }, + { + "name": "symbol_type", + "type": "str | None", + "description": "Restrict to one instrument type.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Equity", + "value": "Equity" + }, + { + "label": "ETF", + "value": "ETF" + }, + { + "label": "Mutual Fund", + "value": "Mutual Fund" + }, + { + "label": "Money Market Fund", + "value": "Money Market Fund" + }, + { + "label": "Index", + "value": "Index" + }, + { + "label": "Future", + "value": "Future" + } + ] + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Two-letter country code, or None for every market.", + "default": "CA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Canada", + "value": "CA" + }, + { + "label": "United States", + "value": "US" + }, + { + "label": "United Kingdom", + "value": "GB" + } + ] + } + } + }, + { + "name": "sector", + "type": "str | None", + "description": "Restrict to one sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Consumer Discretionary", + "value": "consumer_discretionary" + }, + { + "label": "Consumer Staples", + "value": "consumer_staples" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Finance", + "value": "finance" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Materials", + "value": "materials" + }, + { + "label": "Media", + "value": "media" + }, + { + "label": "Real Estate", + "value": "real_estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ] + } + } + }, + { + "name": "industry_group", + "type": "str | None", + "description": "Restrict to one industry group.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/tmx/equity/screener_choices", + "optionsParams": { + "field": "industry_group", + "parent": "$sector" + } + } + } + }, + { + "name": "industry", + "type": "str | None", + "description": "Restrict to one industry.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/tmx/equity/screener_choices", + "optionsParams": { + "field": "industry", + "parent": "$industry_group" + } + } + } + }, + { + "name": "optionable", + "type": "bool | None", + "description": "Restrict to instruments with listed options.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "primary_symbol", + "type": "bool | None", + "description": "Restrict to primary exchange listings.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "filing_current", + "type": "bool | None", + "description": "Restrict to issuers whose filings are current.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "above_52w_high", + "type": "bool | None", + "description": "Restrict to issues trading above their 52-week high.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "below_52w_low", + "type": "bool | None", + "description": "Restrict to issues trading below their 52-week low.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "market_cap_min", + "type": "float | None", + "description": "Minimum market capitalization.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "market_cap_max", + "type": "float | None", + "description": "Maximum market capitalization.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "price_min", + "type": "float | None", + "description": "Minimum stock price.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "price_max", + "type": "float | None", + "description": "Maximum stock price.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "price_change_min", + "type": "float | None", + "description": "Minimum price change, as a normalized percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "price_change_max", + "type": "float | None", + "description": "Maximum price change, as a normalized percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_yield_min", + "type": "float | None", + "description": "Minimum dividend yield, in percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_yield_max", + "type": "float | None", + "description": "Maximum dividend yield, in percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_rate_min", + "type": "float | None", + "description": "Minimum dividend rate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_rate_max", + "type": "float | None", + "description": "Maximum dividend rate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_growth_3y_min", + "type": "float | None", + "description": "Minimum three-year average dividend growth rate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_growth_3y_max", + "type": "float | None", + "description": "Maximum three-year average dividend growth rate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_growth_5y_min", + "type": "float | None", + "description": "Minimum five-year average dividend growth rate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "dividend_growth_5y_max", + "type": "float | None", + "description": "Maximum five-year average dividend growth rate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pe_ratio_min", + "type": "float | None", + "description": "Minimum price-to-earnings ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pe_ratio_max", + "type": "float | None", + "description": "Maximum price-to-earnings ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ps_ratio_min", + "type": "float | None", + "description": "Minimum price-to-sales ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ps_ratio_max", + "type": "float | None", + "description": "Maximum price-to-sales ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pb_ratio_min", + "type": "float | None", + "description": "Minimum price-to-book ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pb_ratio_max", + "type": "float | None", + "description": "Maximum price-to-book ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pcf_ratio_min", + "type": "float | None", + "description": "Minimum price-to-cash-flow ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "pcf_ratio_max", + "type": "float | None", + "description": "Maximum price-to-cash-flow ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "book_value_per_share_min", + "type": "float | None", + "description": "Minimum book value per share.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "book_value_per_share_max", + "type": "float | None", + "description": "Maximum book value per share.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "current_ratio_min", + "type": "float | None", + "description": "Minimum current ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "current_ratio_max", + "type": "float | None", + "description": "Maximum current ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "quick_ratio_min", + "type": "float | None", + "description": "Minimum quick ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "quick_ratio_max", + "type": "float | None", + "description": "Maximum quick ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "debt_to_equity_min", + "type": "float | None", + "description": "Minimum debt-to-equity ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "debt_to_equity_max", + "type": "float | None", + "description": "Maximum debt-to-equity ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "debt_to_capital_min", + "type": "float | None", + "description": "Minimum debt-to-capital ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "debt_to_capital_max", + "type": "float | None", + "description": "Maximum debt-to-capital ratio.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "eps_min", + "type": "float | None", + "description": "Minimum latest fiscal earnings per share.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "eps_max", + "type": "float | None", + "description": "Maximum latest fiscal earnings per share.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "gross_margin_min", + "type": "float | None", + "description": "Minimum gross margin.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "gross_margin_max", + "type": "float | None", + "description": "Maximum gross margin.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ebitda_margin_min", + "type": "float | None", + "description": "Minimum eBITDA margin.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ebitda_margin_max", + "type": "float | None", + "description": "Maximum eBITDA margin.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ebit_margin_min", + "type": "float | None", + "description": "Minimum eBIT margin.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "ebit_margin_max", + "type": "float | None", + "description": "Maximum eBIT margin.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "return_on_assets_min", + "type": "float | None", + "description": "Minimum return on assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "return_on_assets_max", + "type": "float | None", + "description": "Maximum return on assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "return_on_equity_min", + "type": "float | None", + "description": "Minimum return on equity.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "return_on_equity_max", + "type": "float | None", + "description": "Maximum return on equity.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "return_on_capital_min", + "type": "float | None", + "description": "Minimum return on capital.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "return_on_capital_max", + "type": "float | None", + "description": "Maximum return on capital.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_per_share_min", + "type": "float | None", + "description": "Minimum revenue per share.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_per_share_max", + "type": "float | None", + "description": "Maximum revenue per share.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_ltm_min", + "type": "float | None", + "description": "Minimum revenue over the last twelve months.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_ltm_max", + "type": "float | None", + "description": "Maximum revenue over the last twelve months.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "total_revenue_min", + "type": "float | None", + "description": "Minimum total revenue.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "total_revenue_max", + "type": "float | None", + "description": "Maximum total revenue.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "free_cash_flow_min", + "type": "float | None", + "description": "Minimum free cash flow.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "free_cash_flow_max", + "type": "float | None", + "description": "Maximum free cash flow.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "employees_min", + "type": "float | None", + "description": "Minimum number of employees.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "employees_max", + "type": "float | None", + "description": "Maximum number of employees.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "book_value_min", + "type": "float | None", + "description": "Minimum book value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "book_value_max", + "type": "float | None", + "description": "Maximum book value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "total_equity_min", + "type": "float | None", + "description": "Minimum total equity.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "total_equity_max", + "type": "float | None", + "description": "Maximum total equity.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "total_assets_min", + "type": "float | None", + "description": "Minimum total assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "total_assets_max", + "type": "float | None", + "description": "Maximum total assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "current_liabilities_min", + "type": "float | None", + "description": "Minimum current liabilities.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "current_liabilities_max", + "type": "float | None", + "description": "Maximum current liabilities.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "current_assets_min", + "type": "float | None", + "description": "Minimum current assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "current_assets_max", + "type": "float | None", + "description": "Maximum current assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "beta_min", + "type": "float | None", + "description": "Minimum beta.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "beta_max", + "type": "float | None", + "description": "Maximum beta.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "alpha_min", + "type": "float | None", + "description": "Minimum alpha.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "alpha_max", + "type": "float | None", + "description": "Maximum alpha.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "r_squared_min", + "type": "float | None", + "description": "Minimum r-squared.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "r_squared_max", + "type": "float | None", + "description": "Maximum r-squared.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "standard_deviation_min", + "type": "float | None", + "description": "Minimum standard deviation of returns.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "standard_deviation_max", + "type": "float | None", + "description": "Maximum standard deviation of returns.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_min", + "type": "float | None", + "description": "Minimum intraday volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_max", + "type": "float | None", + "description": "Maximum intraday volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_previous_day_min", + "type": "float | None", + "description": "Minimum previous session volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_previous_day_max", + "type": "float | None", + "description": "Maximum previous session volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_10d_min", + "type": "float | None", + "description": "Minimum ten-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_10d_max", + "type": "float | None", + "description": "Maximum ten-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_30d_min", + "type": "float | None", + "description": "Minimum thirty-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_30d_max", + "type": "float | None", + "description": "Maximum thirty-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_50d_min", + "type": "float | None", + "description": "Minimum fifty-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_50d_max", + "type": "float | None", + "description": "Maximum fifty-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_90d_min", + "type": "float | None", + "description": "Minimum ninety-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_avg_90d_max", + "type": "float | None", + "description": "Maximum ninety-day average volume.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "trade_value_avg_90d_min", + "type": "float | None", + "description": "Minimum ninety-day average trade value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "trade_value_avg_90d_max", + "type": "float | None", + "description": "Maximum ninety-day average trade value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "insider_holdings_min", + "type": "float | None", + "description": "Minimum insider holdings, in percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "insider_holdings_max", + "type": "float | None", + "description": "Maximum insider holdings, in percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "institutional_holdings_min", + "type": "float | None", + "description": "Minimum institutional ownership, in percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "institutional_holdings_max", + "type": "float | None", + "description": "Maximum institutional ownership, in percent.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_7d_min", + "type": "float | None", + "description": "Minimum seven-day price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_7d_max", + "type": "float | None", + "description": "Maximum seven-day price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_30d_min", + "type": "float | None", + "description": "Minimum thirty-day price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_30d_max", + "type": "float | None", + "description": "Maximum thirty-day price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_90d_min", + "type": "float | None", + "description": "Minimum ninety-day price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_90d_max", + "type": "float | None", + "description": "Maximum ninety-day price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_ytd_min", + "type": "float | None", + "description": "Minimum year-to-date price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "performance_ytd_max", + "type": "float | None", + "description": "Maximum year-to-date price performance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "change_52w_min", + "type": "float | None", + "description": "Minimum fifty-two week change.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "change_52w_max", + "type": "float | None", + "description": "Maximum fifty-two week change.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "high_52w_min", + "type": "float | None", + "description": "Minimum fifty-two week high price.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "high_52w_max", + "type": "float | None", + "description": "Maximum fifty-two week high price.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "low_52w_min", + "type": "float | None", + "description": "Minimum fifty-two week low price.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "low_52w_max", + "type": "float | None", + "description": "Maximum fifty-two week low price.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_growth_3y_min", + "type": "float | None", + "description": "Minimum three-year annual revenue growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_growth_3y_max", + "type": "float | None", + "description": "Maximum three-year annual revenue growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_growth_5y_min", + "type": "float | None", + "description": "Minimum five-year annual revenue growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "revenue_growth_5y_max", + "type": "float | None", + "description": "Maximum five-year annual revenue growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "income_growth_3y_min", + "type": "float | None", + "description": "Minimum three-year annual income growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "income_growth_3y_max", + "type": "float | None", + "description": "Maximum three-year annual income growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "income_growth_5y_min", + "type": "float | None", + "description": "Minimum five-year annual income growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "income_growth_5y_max", + "type": "float | None", + "description": "Maximum five-year annual income growth.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "open_interest_min", + "type": "float | None", + "description": "Minimum open interest.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "open_interest_max", + "type": "float | None", + "description": "Maximum open interest.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort_by", + "type": "str | None", + "description": "The field to sort by, named as the query parameter.", + "default": "market_cap", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort_order", + "type": "str | None", + "description": "The direction to sort in.", + "default": "DESC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fundamentals", + "type": "bool | None", + "description": "Join the screener fundamentals onto the matched universe.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of results to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEquityScreener", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the instrument.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The listing venue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country of listing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol_type", + "type": "str | None", + "description": "The instrument type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "date | None", + "description": "The delivery month of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency the instrument trades in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "int | None", + "description": "The published sector, industry group, and industry code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_symbol", + "type": "bool | None", + "description": "Whether this is the primary listing of the issue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_current", + "type": "bool | None", + "description": "Whether the issuer's filings are current.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "optionable", + "type": "bool | None", + "description": "Whether the instrument has listed options.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market capitalization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "intraday_market_cap", + "type": "float | None", + "description": "The intraday market capitalization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The last price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_price", + "type": "float | None", + "description": "The exchange's settlement price for the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "intraday_price", + "type": "float | None", + "description": "The intraday price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The session's opening price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The session's high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The session's low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous session's closing price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_change", + "type": "float | None", + "description": "The price change, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "net_change", + "type": "float | None", + "description": "The change in price from the previous session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_52w", + "type": "float | None", + "description": "The fifty-two week high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low_52w", + "type": "float | None", + "description": "The fifty-two week low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "above_52w_high", + "type": "bool | None", + "description": "Whether the issue trades above its fifty-two week high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "below_52w_low", + "type": "bool | None", + "description": "Whether the issue trades below its fifty-two week low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_52w", + "type": "float | None", + "description": "The fifty-two week change, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "performance_7d", + "type": "float | None", + "description": "The seven-day price performance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "performance_30d", + "type": "float | None", + "description": "The thirty-day price performance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "performance_90d", + "type": "float | None", + "description": "The ninety-day price performance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "performance_ytd", + "type": "float | None", + "description": "The year-to-date price performance.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "int | None", + "description": "The intraday volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "int | None", + "description": "The number of contracts outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transactions", + "type": "int | None", + "description": "The number of transactions in the session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_previous_day", + "type": "int | None", + "description": "The previous session volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_10d", + "type": "int | None", + "description": "The ten-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_30d", + "type": "int | None", + "description": "The thirty-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_50d", + "type": "int | None", + "description": "The fifty-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_90d", + "type": "int | None", + "description": "The ninety-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_value_avg_90d", + "type": "float | None", + "description": "The ninety-day average trade value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "beta", + "type": "float | None", + "description": "Beta.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "alpha", + "type": "float | None", + "description": "Alpha.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "r_squared", + "type": "float | None", + "description": "R-squared.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standard_deviation", + "type": "float | None", + "description": "The standard deviation of returns.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "insider_holdings", + "type": "float | None", + "description": "Insider holdings, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "institutional_holdings", + "type": "float | None", + "description": "Institutional ownership, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pe_ratio", + "type": "float | None", + "description": "The price-to-earnings ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ps_ratio", + "type": "float | None", + "description": "The price-to-sales ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pb_ratio", + "type": "float | None", + "description": "The price-to-book ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pcf_ratio", + "type": "float | None", + "description": "The price-to-cash-flow ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "book_value_per_share", + "type": "float | None", + "description": "The book value per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps", + "type": "float | None", + "description": "The latest fiscal earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_ratio", + "type": "float | None", + "description": "The current ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quick_ratio", + "type": "float | None", + "description": "The quick ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debt_to_equity", + "type": "float | None", + "description": "The debt-to-equity ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debt_to_capital", + "type": "float | None", + "description": "The debt-to-capital ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_margin", + "type": "float | None", + "description": "The gross margin.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ebitda_margin", + "type": "float | None", + "description": "The EBITDA margin.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ebit_margin", + "type": "float | None", + "description": "The EBIT margin.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_on_assets", + "type": "float | None", + "description": "The return on assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_on_equity", + "type": "float | None", + "description": "The return on equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_on_capital", + "type": "float | None", + "description": "The return on capital.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "The dividend yield, in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_rate", + "type": "float | None", + "description": "The dividend rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_growth_3y", + "type": "float | None", + "description": "The three-year average dividend growth rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_growth_5y", + "type": "float | None", + "description": "The five-year average dividend growth rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_ltm", + "type": "float | None", + "description": "The revenue over the last twelve months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_revenue", + "type": "float | None", + "description": "The total revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_per_share", + "type": "float | None", + "description": "The revenue per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_growth_3y", + "type": "float | None", + "description": "The three-year annual revenue growth.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_growth_5y", + "type": "float | None", + "description": "The five-year annual revenue growth.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_growth_3y", + "type": "float | None", + "description": "The three-year annual income growth.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_growth_5y", + "type": "float | None", + "description": "The five-year annual income growth.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "free_cash_flow", + "type": "float | None", + "description": "The free cash flow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "book_value", + "type": "float | None", + "description": "The book value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "float | None", + "description": "Total assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_equity", + "type": "float | None", + "description": "Total equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_assets", + "type": "float | None", + "description": "Current assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_liabilities", + "type": "float | None", + "description": "Current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employees", + "type": "int | None", + "description": "The number of employees.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEquityScreener", + "openapi_extra": { + "model": "TmxEquityScreener" + } + }, + "/tmx/equity/quote": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Delayed quote, for any symbol the feed addresses.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Delayed quote for a listing.\nobb.tmx.equity.quote(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + } + ], + "tmx": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEquityQuote", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company or asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "Price of the top bid order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "str | None", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "Price of the top ask order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "str | None", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_indicators", + "type": "int | list[int] | list[str] | str | None", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sequence_number", + "type": "int | None", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_center", + "type": "str | None", + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "participant_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trf_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sip_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "Price of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_tick", + "type": "str | None", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_size", + "type": "int | None", + "description": "Size of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_timestamp", + "type": "datetime | None", + "description": "Date and Time when the last price was recorded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_volume", + "type": "float | int | None", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price from previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "The one year high (52W High).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The one year low (52W Low).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "name", + "type": "str | None", + "description": "The name of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The listing exchange code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last price of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "None", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change in price as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "Fifty-two week high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "Fifty-two week low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The issuance type of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The sector of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_category", + "type": "str | None", + "description": "The industry category of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "The industry group of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ma_21", + "type": "float | None", + "description": "Twenty-one day moving average.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ma_50", + "type": "float | None", + "description": "Fifty day moving average.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ma_200", + "type": "float | None", + "description": "Two-hundred day moving average.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_10d", + "type": "int | None", + "description": "Ten day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_30d", + "type": "int | None", + "description": "Thirty day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_50d", + "type": "int | None", + "description": "Fifty day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "int | None", + "description": "Market capitalization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap_all_classes", + "type": "int | None", + "description": "Market capitalization of all share classes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "div_amount", + "type": "float | None", + "description": "The most recent dividend amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "div_currency", + "type": "str | None", + "description": "The currency the dividend is paid in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "div_yield", + "type": "float | None", + "description": "The dividend yield as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "div_freq", + "type": "str | None", + "description": "The frequency of dividend payments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "div_ex_date", + "type": "date | None", + "description": "The ex-dividend date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "div_pay_date", + "type": "date | None", + "description": "The next dividend ayment date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "div_growth_3y", + "type": "float | str | None", + "description": "The three year dividend growth as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "div_growth_5y", + "type": "float | str | None", + "description": "The five year dividend growth as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "pe", + "type": "float | str | None", + "description": "The price to earnings ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps", + "type": "float | str | None", + "description": "The earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debt_to_equity", + "type": "float | str | None", + "description": "The debt to equity ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_book", + "type": "float | str | None", + "description": "The price to book ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_cf", + "type": "float | str | None", + "description": "The price to cash flow ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_on_equity", + "type": "float | str | None", + "description": "The return on equity, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_on_assets", + "type": "float | str | None", + "description": "The return on assets, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta", + "type": "float | str | None", + "description": "The beta relative to the TSX Composite.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "alpha", + "type": "float | str | None", + "description": "The alpha relative to the TSX Composite.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_outstanding", + "type": "int | None", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_escrow", + "type": "int | None", + "description": "The number of shares held in escrow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_total", + "type": "int | None", + "description": "The total number of shares outstanding from all classes.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEquityQuote", + "openapi_extra": { + "model": "TmxEquityQuote" + } + }, + "/tmx/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company profile, sector, and reference data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Company profile and reference data.\nobb.tmx.equity.profile(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + } + ], + "tmx": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEquityInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Common name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legal_name", + "type": "str | None", + "description": "Official legal name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_exchange", + "type": "str | None", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sic", + "type": "int | None", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_description", + "type": "str | None", + "description": "Short description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_description", + "type": "str | None", + "description": "Long description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ceo", + "type": "str | None", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_url", + "type": "str | None", + "description": "URL of the company's website.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_address", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mailing_address", + "type": "str | None", + "description": "Mailing address of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_phone_no", + "type": "str | None", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address1", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address2", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_city", + "type": "str | None", + "description": "City of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_postal_code", + "type": "str | None", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_state", + "type": "str | None", + "description": "State of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_country", + "type": "str | None", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_state", + "type": "str | None", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_country", + "type": "str | None", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employees", + "type": "int | None", + "description": "Number of employees working for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_legal_form", + "type": "str | None", + "description": "Legal form of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_status", + "type": "str | None", + "description": "Status of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_filing_date", + "type": "date | None", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "irs_number", + "type": "str | None", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_category", + "type": "str | None", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "template", + "type": "str | None", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standardized_active", + "type": "bool | None", + "description": "Whether the company is active or not.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_fundamental_date", + "type": "date | None", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_fundamental_date", + "type": "date | None", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_stock_price_date", + "type": "date | None", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_stock_price_date", + "type": "date | None", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "email", + "type": "str | None", + "description": "The email of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_type", + "type": "str | None", + "description": "The issuance type of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_outstanding", + "type": "int | None", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_escrow", + "type": "int | None", + "description": "The number of shares held in escrow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_total", + "type": "int | None", + "description": "The total number of shares outstanding from all classes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_frequency", + "type": "str | None", + "description": "The dividend frequency.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEquityInfo", + "openapi_extra": { + "model": "TmxEquityInfo" + } + }, + "/tmx/equity/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical prices for any listed instrument.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily price history.\nobb.tmx.equity.historical(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022.", + "default": "day", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The adjustment factor to apply. Only valid for daily data.", + "default": "splits_only", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Splits Only", + "value": "splits_only" + }, + { + "label": "Splits and Dividends", + "value": "splits_and_dividends" + }, + { + "label": "Unadjusted", + "value": "unadjusted" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEquityHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "high", + "type": "float | None", + "description": "The high price. The feed leaves it empty on a handful of historical foreign bars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price. The feed leaves it empty on a handful of historical foreign bars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume weighted average price for the day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "transactions", + "type": "int | None", + "description": "Total number of transactions recorded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transactions_value", + "type": "float | None", + "description": "Nominal value of recorded transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEquityHistorical", + "openapi_extra": { + "widget_config": { + "name": "TMX Historical Price", + "description": "Historical prices, charted over the TMX quote feed.", + "category": "Markets", + "type": "advanced_charting", + "endpoint": "api/v1/tmx/udf", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "defaultSymbol": "AC", + "updateFrequency": 60000 + } + }, + "model": "TmxEquityHistorical" + } + }, + "/tmx/equity/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Filings published to SEDAR, with links to the PDFs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# SEDAR filings with document links.\nobb.tmx.equity.filings(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "The start date to fetch.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "The end date to fetch.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxCompanyFilings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "Type of filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "description", + "type": "str", + "description": "The description of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "size", + "type": "str | None", + "description": "The file size of the PDF document.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxCompanyFilings", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "TmxCompanyFilings" + } + }, + "/tmx/equity/gainers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Curated stock lists of gainers and most actives.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The most active and best performing listings.\nobb.tmx.equity.gainers(provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "sort", + "type": "str | None", + "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "category", + "type": "str | None", + "description": "The category of list to retrieve. Defaults to `price_performer`.", + "default": "price_performer", + "optional": true, + "choices": [ + "dividend", + "energy", + "healthcare", + "industrials", + "price_performer", + "rising_stars", + "real_estate", + "tech", + "utilities", + "52w_high", + "volume", + "cdr" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Dividend", + "value": "dividend" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Price Performer", + "value": "price_performer" + }, + { + "label": "Rising Stars", + "value": "rising_stars" + }, + { + "label": "Real Estate", + "value": "real_estate" + }, + { + "label": "Tech", + "value": "tech" + }, + { + "label": "Utilities", + "value": "utilities" + }, + { + "label": "52-Week High", + "value": "52w_high" + }, + { + "label": "Volume", + "value": "volume" + }, + { + "label": "CDR", + "value": "cdr" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEquityGainers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "float", + "description": "Change in price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "thirty_day_price_change", + "type": "float | None", + "description": "30 Day Price Change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ninety_day_price_change", + "type": "float | None", + "description": "90 Day Price Change.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "Dividend Yield.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "avg_volume_10d", + "type": "float | None", + "description": "10 Day Avg. Volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rank", + "type": "int", + "description": "The rank of the stock in the list.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEquityGainers", + "openapi_extra": { + "model": "TmxEquityGainers" + } + }, + "/tmx/equity/rankings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Read the TSX 30 and TSX Venture 50 annual rankings.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The Toronto Stock Exchange's top thirty performers.\nobb.tmx.equity.rankings(ranking='tsx30', provider='tmx')\n# The TSX Venture Exchange's top fifty performers.\nobb.tmx.equity.rankings(ranking='venture50', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "ranking", + "type": "str | None", + "description": "The published ranking. 'tsx30' is the Toronto Stock Exchange's top thirty performers, 'venture50' the TSX Venture Exchange's top fifty.", + "default": "tsx30", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "TSX 30", + "value": "tsx30" + }, + { + "label": "TSX Venture 50", + "value": "venture50" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. The rankings are published annually and cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxRankings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "rank", + "type": "int | None", + "description": "The position in the ranking.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The sector of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry", + "type": "str | None", + "description": "The industry of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "location", + "type": "str | None", + "description": "The province the company is headquartered in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "share_price_appreciation", + "type": "float | None", + "description": "The share price appreciation over the ranking period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap_change", + "type": "float | None", + "description": "The change in market capitalization over the ranking period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "A description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "The company's website.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "logo_url", + "type": "str | None", + "description": "The company's logo.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxRankings", + "openapi_extra": { + "widget_config": { + "name": "TMX Annual Rankings", + "description": "The TSX 30 and TSX Venture 50 published rankings.", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 15 + } + }, + "model": "TmxRankings" + } + }, + "/tmx/equity/symbol_reference": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Resolve symbols to their canonical form, validity, and listing venue.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Resolve symbols to their canonical form and venue.\nobb.tmx.equity.symbol_reference(symbol='AC,IBM:US,$USDCAD', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SymbolReference", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "is_valid", + "type": "bool | None", + "description": "Whether the feed resolves the symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "resolved_symbol", + "type": "str | None", + "description": "The canonical symbol the feed addresses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange code the symbol resolves to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_short_name", + "type": "str | None", + "description": "The short name of the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_name", + "type": "str | None", + "description": "The full name of the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "SymbolReference", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "SymbolReference" + } + }, + "/tmx/equity/filings_view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve every selected filing to the viewer.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "params", + "type": "FilingRequest", + "description": "", + "default": null, + "optional": false + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Company Filings", + "description": "Documents filed to SEDAR, read as PDFs.", + "type": "multi_file_viewer", + "category": "Equity", + "subCategory": "Filings", + "widgetId": "tmx_equity_filings_viewer_obb", + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "description": "The symbol to read filings for.", + "value": "AC" + }, + { + "paramName": "start_date", + "label": "Start Date", + "description": "The first filing date to offer.", + "type": "date" + }, + { + "paramName": "end_date", + "label": "End Date", + "description": "The last filing date to offer.", + "type": "date" + }, + { + "paramName": "url", + "type": "endpoint", + "optionsEndpoint": "/api/v1/tmx/equity/filing_choices", + "optionsParams": { + "symbol": "$symbol", + "start_date": "$start_date", + "end_date": "$end_date" + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + } + ], + "gridData": { + "w": 20, + "h": 28 + }, + "refetchInterval": false, + "source": [ + "TMX" + ] + } + } + }, + "/tmx/equity/screener_builder": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open the interactive TMX screener builder.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Open the screener builder in a native window.\nobb.tmx.equity.screener_builder()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/tmx/equity/screener_builder/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the interactive screener-builder iframe page.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Screener Builder", + "description": "Build a screen across every published TMX filter, then run it against the listed universe.", + "type": "iframe", + "category": "Equity", + "subCategory": "Screener", + "widgetId": "tmx_equity_screener_builder_obb", + "params": [ + { + "paramName": "config", + "label": "Screener Config", + "value": "", + "description": "The configuration the builder emits.", + "show": false + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 40, + "h": 20 + }, + "refetchInterval": false, + "source": [ + "TMX" + ] + } + } + }, + "/tmx/equity/asset_info/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the styled asset overview for the Workspace.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AC", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Asset Info", + "description": "A styled overview of the symbol - session, performance, valuation, analysts, ownership, calendar, and, for a fund, its facts, holdings, and weightings.", + "type": "iframe", + "category": "Equity", + "subCategory": "Profile", + "widgetId": "tmx_equity_asset_info_obb", + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AC", + "description": "The symbol to describe." + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 20, + "h": 20 + }, + "refetchInterval": false, + "source": [ + "TMX" + ] + } + } + }, + "/tmx/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Income statement, annual or quarterly.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Income statement.\nobb.tmx.equity.fundamental.income(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarter", + "value": "quarter" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIncomeStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "reported_currency", + "type": "str | None", + "description": "The currency the statement is reported in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_revenue", + "type": "float | None", + "description": "Total revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_revenue", + "type": "float | None", + "description": "Operating revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commission_revenue", + "type": "float | None", + "description": "Commission revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fee_revenue_and_other_income", + "type": "float | None", + "description": "Fee revenue and other income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fees", + "type": "float | None", + "description": "Fees.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fees_and_commissions", + "type": "float | None", + "description": "Fees and commissions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "agency_fees_and_commissions", + "type": "float | None", + "description": "Agency fees and commissions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_income", + "type": "float | None", + "description": "Dividend income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_customer_services", + "type": "float | None", + "description": "Other customer services.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "service_charge_on_depositor_accounts", + "type": "float | None", + "description": "Service charge on depositor accounts.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credit_card", + "type": "float | None", + "description": "Credit card.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_activities", + "type": "float | None", + "description": "Securities activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_banking_profit", + "type": "float | None", + "description": "Investment banking profit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trading_gain_loss", + "type": "float | None", + "description": "Trading gain loss.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trust_fees_by_commissions", + "type": "float | None", + "description": "Trust fees by commissions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income", + "type": "float | None", + "description": "Interest income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_operating", + "type": "float | None", + "description": "Interest income operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_loans", + "type": "float | None", + "description": "Interest income from loans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_loans_and_lease", + "type": "float | None", + "description": "Interest income from loans and lease.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_securities", + "type": "float | None", + "description": "Interest income from securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_investment_securities", + "type": "float | None", + "description": "Interest income from investment securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_deposits", + "type": "float | None", + "description": "Interest income from deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_federal_funds_sold_and_securities_purchase_under_agreements_to_resell", + "type": "float | None", + "description": "Interest income from federal funds sold and securities purchase under agreements to resell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_from_other_money_market_investments", + "type": "float | None", + "description": "Interest income from other money market investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_interest_income", + "type": "float | None", + "description": "Other interest income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense", + "type": "float | None", + "description": "Interest expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_operating", + "type": "float | None", + "description": "Interest expense operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_for_deposit", + "type": "float | None", + "description": "Interest expense for deposit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_for_long_term_debt", + "type": "float | None", + "description": "Interest expense for long term debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_for_long_term_debt_and_capital_securities", + "type": "float | None", + "description": "Interest expense for long term debt and capital securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_for_capitalized_lease_obligations", + "type": "float | None", + "description": "Interest expense for capitalized lease obligations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_for_federal_funds_sold_and_securities_purchase_under_agreements_to_resell", + "type": "float | None", + "description": "Interest expense for federal funds sold and securities purchase under agreements to resell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_interest_expense", + "type": "float | None", + "description": "Other interest expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_interest_income", + "type": "float | None", + "description": "Net interest income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_operating_interest_income_expense", + "type": "float | None", + "description": "Net operating interest income expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "credit_losses_provision", + "type": "float | None", + "description": "Credit losses provision.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_after_provision_for_loan_loss", + "type": "float | None", + "description": "Interest income after provision for loan loss.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_interest_income", + "type": "float | None", + "description": "Non interest income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_interest_income", + "type": "float | None", + "description": "Other non interest income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_interest_expense", + "type": "float | None", + "description": "Non interest expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_interest_expense", + "type": "float | None", + "description": "Other non interest expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_occupancy_expense", + "type": "float | None", + "description": "Net occupancy expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "occupancy_and_equipment", + "type": "float | None", + "description": "Occupancy and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_premiums_written", + "type": "float | None", + "description": "Gross premiums written.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ceded_premiums", + "type": "float | None", + "description": "Ceded premiums.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_premiums_written", + "type": "float | None", + "description": "Net premiums written.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "increase_decrease_in_net_unearned_premium_reserves", + "type": "float | None", + "description": "Increase decrease in net unearned premium reserves.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_premiums_earned", + "type": "float | None", + "description": "Total premiums earned.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "insurance_and_premiums", + "type": "float | None", + "description": "Insurance and premiums.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_investment_income", + "type": "float | None", + "description": "Net investment income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_realized_gain_loss_on_investments", + "type": "float | None", + "description": "Net realized gain loss on investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "policy_acquisition_expense", + "type": "float | None", + "description": "Policy acquisition expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "policyholder_benefits_ceded", + "type": "float | None", + "description": "Policyholder benefits ceded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acquisition_expense", + "type": "float | None", + "description": "Acquisition expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underwriting_expenses", + "type": "float | None", + "description": "Underwriting expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "insurance_and_claims", + "type": "float | None", + "description": "Insurance and claims.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commission_expenses", + "type": "float | None", + "description": "Commission expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cost_of_revenue", + "type": "float | None", + "description": "Cost of revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_cost_of_revenue", + "type": "float | None", + "description": "Other cost of revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_profit", + "type": "float | None", + "description": "Gross profit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "salaries_and_wages", + "type": "float | None", + "description": "Salaries and wages.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "selling_and_marketing_expense", + "type": "float | None", + "description": "Selling and marketing expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "marketing_expense", + "type": "float | None", + "description": "Marketing expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "promotion_and_advertising", + "type": "float | None", + "description": "Promotion and advertising.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "general_and_administrative_expense", + "type": "float | None", + "description": "General and administrative expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_general_and_administrative", + "type": "float | None", + "description": "Other general and administrative.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "selling_general_and_administration", + "type": "float | None", + "description": "Selling general and administration.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "research_and_development", + "type": "float | None", + "description": "Research and development.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "research_expense", + "type": "float | None", + "description": "Research expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "professional_expense_and_contract_services_expense", + "type": "float | None", + "description": "Professional expense and contract services expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maintenance_and_repairs", + "type": "float | None", + "description": "Maintenance and repairs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operation_and_maintenance", + "type": "float | None", + "description": "Operation and maintenance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rent_and_landing_fees", + "type": "float | None", + "description": "Rent and landing fees.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fuel", + "type": "float | None", + "description": "Fuel.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equipment", + "type": "float | None", + "description": "Equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exploration_development_and_mineral_property_lease_expenses", + "type": "float | None", + "description": "Exploration development and mineral property lease expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_taxes", + "type": "float | None", + "description": "Other taxes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_operating_expenses", + "type": "float | None", + "description": "Other operating expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_expense", + "type": "float | None", + "description": "Operating expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_expenses", + "type": "float | None", + "description": "Total expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation", + "type": "float | None", + "description": "Depreciation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization", + "type": "float | None", + "description": "Amortization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_of_intangibles", + "type": "float | None", + "description": "Amortization of intangibles.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depletion", + "type": "float | None", + "description": "Depletion.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_and_amortization", + "type": "float | None", + "description": "Depreciation and amortization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_amortization_depletion", + "type": "float | None", + "description": "Depreciation amortization depletion.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_income", + "type": "float | None", + "description": "Operating income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ebitda", + "type": "float | None", + "description": "EBITDA.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ebit", + "type": "float | None", + "description": "EBIT.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_income_non_operating", + "type": "float | None", + "description": "Interest income non operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_expense_non_operating", + "type": "float | None", + "description": "Interest expense non operating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_non_operating_interest_income_expense", + "type": "float | None", + "description": "Net non operating interest income expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_from_equity_interest", + "type": "float | None", + "description": "Earnings from equity interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_from_equity_interest_net_of_tax", + "type": "float | None", + "description": "Earnings from equity interest net of tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earning_loss_of_equity_investments", + "type": "float | None", + "description": "Earning loss of equity investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_on_sale_of_business", + "type": "float | None", + "description": "Gain on sale of business.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_on_sale_of_ppe", + "type": "float | None", + "description": "Gain on sale of property, plant and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_on_sale_of_security", + "type": "float | None", + "description": "Gain on sale of security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "impairment_of_capital_assets", + "type": "float | None", + "description": "Impairment of capital assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_impairment_of_capital_assets", + "type": "float | None", + "description": "Other impairment of capital assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "write_off", + "type": "float | None", + "description": "Write off.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restructuring_and_merger_acquisition_income", + "type": "float | None", + "description": "Restructuring and merger acquisition income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restructuring_and_merger_and_acquisition", + "type": "float | None", + "description": "Restructuring and merger and acquisition.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "special_income_charges", + "type": "float | None", + "description": "Special income charges.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_special_charges", + "type": "float | None", + "description": "Other special charges.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "misc_other_special_charges", + "type": "float | None", + "description": "Misc other special charges.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_income_expense", + "type": "float | None", + "description": "Other income expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pretax_income", + "type": "float | None", + "description": "Pretax income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tax_provision", + "type": "float | None", + "description": "Tax provision.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minority_interests", + "type": "float | None", + "description": "Minority interests.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_continuous_operations", + "type": "float | None", + "description": "Net income continuous operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_discontinuous_operations", + "type": "float | None", + "description": "Net income discontinuous operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_gain_loss_from_disposition_of_discontinued_operations", + "type": "float | None", + "description": "Other gain loss from disposition of discontinued operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_extraordinary", + "type": "float | None", + "description": "Net income extraordinary.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_from_continuing_and_discontinued_operation", + "type": "float | None", + "description": "Net income from continuing and discontinued operation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income", + "type": "float | None", + "description": "Net income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_stock_dividends", + "type": "float | None", + "description": "Preferred stock dividends.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_preferred_stock_dividends", + "type": "float | None", + "description": "Accrued preferred stock dividends.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accretion_on_preferred_stock", + "type": "float | None", + "description": "Accretion on preferred stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_common_stockholders", + "type": "float | None", + "description": "Net income common stockholders.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "normalized_income", + "type": "float | None", + "description": "Normalized income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basic_eps", + "type": "float | None", + "description": "Basic earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diluted_eps", + "type": "float | None", + "description": "Diluted earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basic_continuous_operations", + "type": "float | None", + "description": "Basic continuous operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diluted_continuous_operations", + "type": "float | None", + "description": "Diluted continuous operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basic_discontinuous_operations", + "type": "float | None", + "description": "Basic discontinuous operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diluted_discontinuous_operations", + "type": "float | None", + "description": "Diluted discontinuous operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_per_share", + "type": "float | None", + "description": "Dividend per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "basic_average_shares", + "type": "float | None", + "description": "Basic average shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "diluted_average_shares", + "type": "float | None", + "description": "Diluted average shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_outstanding", + "type": "float | None", + "description": "Shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "share_class_level_shares_outstanding", + "type": "float | None", + "description": "Share class level shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxIncomeStatement", + "openapi_extra": { + "widget_config": { + "data": { + "table": { + "transpose": true + } + } + }, + "model": "TmxIncomeStatement" + } + }, + "/tmx/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Balance sheet, annual or quarterly.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Balance sheet.\nobb.tmx.equity.fundamental.balance(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarter", + "value": "quarter" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxBalanceSheet", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "reported_currency", + "type": "str | None", + "description": "The currency the statement is reported in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash", + "type": "float | None", + "description": "Cash.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_equivalents", + "type": "float | None", + "description": "Cash equivalents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_and_cash_equivalents", + "type": "float | None", + "description": "Cash and cash equivalents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_and_due_from_banks", + "type": "float | None", + "description": "Cash and due from banks.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restricted_cash", + "type": "float | None", + "description": "Restricted cash.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restricted_cash_and_cash_equivalents", + "type": "float | None", + "description": "Restricted cash and cash equivalents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restricted_cash_and_investments", + "type": "float | None", + "description": "Restricted cash and investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "restricted_investments", + "type": "float | None", + "description": "Restricted investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_investments", + "type": "float | None", + "description": "Short term investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_investments_available_for_sale", + "type": "float | None", + "description": "Short term investments available for sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_cash_equivalents_and_short_term_investments", + "type": "float | None", + "description": "Cash cash equivalents and short term investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "money_market_investments", + "type": "float | None", + "description": "Money market investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_bearing_deposits_assets", + "type": "float | None", + "description": "Interest bearing deposits assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accounts_receivable", + "type": "float | None", + "description": "Accounts receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_accounts_receivable", + "type": "float | None", + "description": "Gross accounts receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receivables", + "type": "float | None", + "description": "Receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_receivables", + "type": "float | None", + "description": "Other receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "notes_receivable", + "type": "float | None", + "description": "Notes receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_note_receivables", + "type": "float | None", + "description": "Non current note receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_accounts_receivable", + "type": "float | None", + "description": "Non current accounts receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "taxes_receivable", + "type": "float | None", + "description": "Taxes receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "receivables_adjustments_allowances", + "type": "float | None", + "description": "Receivables adjustments allowances.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "premiums_receivable", + "type": "float | None", + "description": "Premiums receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reinsurance_receivables", + "type": "float | None", + "description": "Reinsurance receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_investment_income", + "type": "float | None", + "description": "Accrued investment income.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inventory", + "type": "float | None", + "description": "Inventory.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "raw_materials", + "type": "float | None", + "description": "Raw materials.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "work_in_process", + "type": "float | None", + "description": "Work in process.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "finished_goods", + "type": "float | None", + "description": "Finished goods.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchased_components", + "type": "float | None", + "description": "Purchased components.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_inventories", + "type": "float | None", + "description": "Other inventories.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "materials_and_supplies", + "type": "float | None", + "description": "Materials and supplies.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "natural_gas_fuel_and_other", + "type": "float | None", + "description": "Natural gas fuel and other.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inventories_adjustments_allowances", + "type": "float | None", + "description": "Inventories adjustments allowances.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prepaid_assets", + "type": "float | None", + "description": "Prepaid assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_prepaid_assets", + "type": "float | None", + "description": "Non current prepaid assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_assets", + "type": "float | None", + "description": "Other current assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_assets", + "type": "float | None", + "description": "Current deferred assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_taxes_assets", + "type": "float | None", + "description": "Current deferred taxes assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_assets", + "type": "float | None", + "description": "Current assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_loan", + "type": "float | None", + "description": "Gross loan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_loan", + "type": "float | None", + "description": "Net loan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commercial_loan", + "type": "float | None", + "description": "Commercial loan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consumer_loan", + "type": "float | None", + "description": "Consumer loan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mortgage_loan", + "type": "float | None", + "description": "Mortgage loan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mortgage_and_consumer_loans", + "type": "float | None", + "description": "Mortgage and consumer loans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loans_receivable", + "type": "float | None", + "description": "Loans receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "loans_held_for_sale", + "type": "float | None", + "description": "Loans held for sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_loan_assets", + "type": "float | None", + "description": "Other loan assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "allowance_for_loans_and_lease_losses", + "type": "float | None", + "description": "Allowance for loans and lease losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "policy_loans", + "type": "float | None", + "description": "Policy loans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trading_securities", + "type": "float | None", + "description": "Trading securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "available_for_sale_securities", + "type": "float | None", + "description": "Available for sale securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "held_to_maturity_securities", + "type": "float | None", + "description": "Held to maturity securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stocks_available_for_sale", + "type": "float | None", + "description": "Common stocks available for sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_stocks_available_for_sale", + "type": "float | None", + "description": "Preferred stocks available for sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fixed_maturity_investments", + "type": "float | None", + "description": "Fixed maturity investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fixed_maturities_available_for_sale", + "type": "float | None", + "description": "Fixed maturities available for sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fixed_maturities_held_to_maturity", + "type": "float | None", + "description": "Fixed maturities held to maturity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_and_investments", + "type": "float | None", + "description": "Securities and investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_investments", + "type": "float | None", + "description": "Total investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_invested_assets", + "type": "float | None", + "description": "Other invested assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equity_investments", + "type": "float | None", + "description": "Equity investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investments_and_advances", + "type": "float | None", + "description": "Investments and advances.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investments_in_affiliates_subsidiaries_associates_and_joint_ventures", + "type": "float | None", + "description": "Investments in affiliates subsidiaries associates and joint ventures.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investments_in_other_ventures_under_equity_method", + "type": "float | None", + "description": "Investments in other ventures under equity method.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "real_estate_and_real_estate_joint_ventures_held_for_investment", + "type": "float | None", + "description": "Real estate and real estate joint ventures held for investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "derivative_assets", + "type": "float | None", + "description": "Derivative assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_assets", + "type": "float | None", + "description": "Financial assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_borrowed", + "type": "float | None", + "description": "Security borrowed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_agreed_to_be_resold", + "type": "float | None", + "description": "Securities agreed to be resold.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "federal_funds_sold_and_securities_purchase_under_agreements_to_resell", + "type": "float | None", + "description": "Federal funds sold and securities purchase under agreements to resell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "separate_account_assets", + "type": "float | None", + "description": "Separate account assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bank_owned_life_insurance", + "type": "float | None", + "description": "Bank owned life insurance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_ppe", + "type": "float | None", + "description": "Gross property, plant and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accumulated_depreciation", + "type": "float | None", + "description": "Accumulated depreciation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_ppe", + "type": "float | None", + "description": "Net property, plant and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "properties", + "type": "float | None", + "description": "Properties.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_properties", + "type": "float | None", + "description": "Other properties.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "land_and_improvements", + "type": "float | None", + "description": "Land and improvements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "buildings_and_improvements", + "type": "float | None", + "description": "Buildings and improvements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "machinery_furniture_equipment", + "type": "float | None", + "description": "Machinery furniture equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "construction_in_progress", + "type": "float | None", + "description": "Construction in progress.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "flight_fleet_vehicle_and_related_equipments", + "type": "float | None", + "description": "Flight fleet vehicle and related equipments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mineral_properties", + "type": "float | None", + "description": "Mineral properties.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "leases", + "type": "float | None", + "description": "Leases.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "electric_utility_plant", + "type": "float | None", + "description": "Electric utility plant.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_utility_plant", + "type": "float | None", + "description": "Common utility plant.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_utility_plant", + "type": "float | None", + "description": "Net utility plant.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goodwill", + "type": "float | None", + "description": "Goodwill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_intangible_assets", + "type": "float | None", + "description": "Other intangible assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "goodwill_and_other_intangible_assets", + "type": "float | None", + "description": "Goodwill and other intangible assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_assets", + "type": "float | None", + "description": "Deferred assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_tax_assets", + "type": "float | None", + "description": "Deferred tax assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_costs", + "type": "float | None", + "description": "Deferred costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_deferred_costs", + "type": "float | None", + "description": "Other deferred costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_financing_costs", + "type": "float | None", + "description": "Deferred financing costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_policy_acquisition_costs", + "type": "float | None", + "description": "Deferred policy acquisition costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "regulatory_assets", + "type": "float | None", + "description": "Regulatory assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reinsurance_recoverable", + "type": "float | None", + "description": "Reinsurance recoverable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reinsurance_recoverable_for_paid_losses", + "type": "float | None", + "description": "Reinsurance recoverable for paid losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reinsurance_recoverable_for_unpaid_losses", + "type": "float | None", + "description": "Reinsurance recoverable for unpaid losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_deferred_assets", + "type": "float | None", + "description": "Non current deferred assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_deferred_taxes_assets", + "type": "float | None", + "description": "Non current deferred taxes assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_assets", + "type": "float | None", + "description": "Other assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_current_assets", + "type": "float | None", + "description": "Other non current assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_non_current_assets", + "type": "float | None", + "description": "Total non current assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "float | None", + "description": "Total assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accounts_payable", + "type": "float | None", + "description": "Accounts payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_payable", + "type": "float | None", + "description": "Other payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payables", + "type": "float | None", + "description": "Payables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_accrued_expenses", + "type": "float | None", + "description": "Current accrued expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payables_and_accrued_expenses", + "type": "float | None", + "description": "Payables and accrued expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_tax_payable", + "type": "float | None", + "description": "Income tax payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_tax_payable", + "type": "float | None", + "description": "Total tax payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_payable", + "type": "float | None", + "description": "Interest payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividends_payable", + "type": "float | None", + "description": "Dividends payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_notes_payable", + "type": "float | None", + "description": "Current notes payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "line_of_credit", + "type": "float | None", + "description": "Line of credit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_borrowings", + "type": "float | None", + "description": "Other current borrowings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_debt", + "type": "float | None", + "description": "Current debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_capital_lease_obligation", + "type": "float | None", + "description": "Current capital lease obligation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_debt_and_capital_lease_obligation", + "type": "float | None", + "description": "Current debt and capital lease obligation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_revenue", + "type": "float | None", + "description": "Current deferred revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_liabilities", + "type": "float | None", + "description": "Current deferred liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_deferred_taxes_liabilities", + "type": "float | None", + "description": "Current deferred taxes liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_provisions", + "type": "float | None", + "description": "Current provisions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_current_liabilities", + "type": "float | None", + "description": "Other current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_liabilities", + "type": "float | None", + "description": "Current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_interest_bearing_deposits", + "type": "float | None", + "description": "Non interest bearing deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_bearing_deposits_liabilities", + "type": "float | None", + "description": "Interest bearing deposits liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_deposits", + "type": "float | None", + "description": "Other deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_deposits", + "type": "float | None", + "description": "Total deposits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "federal_funds_purchased_and_securities_sold_under_agreement_to_repurchase", + "type": "float | None", + "description": "Federal funds purchased and securities sold under agreement to repurchase.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financial_instruments_sold_under_agreements_to_repurchase", + "type": "float | None", + "description": "Financial instruments sold under agreements to repurchase.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_sold_not_yet_repurchased", + "type": "float | None", + "description": "Security sold not yet repurchased.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trading_liabilities", + "type": "float | None", + "description": "Trading liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "derivative_product_liabilities", + "type": "float | None", + "description": "Derivative product liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bank_acceptance_executed_and_outstanding", + "type": "float | None", + "description": "Bank acceptance executed and outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "customer_acceptances", + "type": "float | None", + "description": "Customer acceptances.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unearned_premiums", + "type": "float | None", + "description": "Unearned premiums.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "future_policy_benefits", + "type": "float | None", + "description": "Future policy benefits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "policyholder_funds", + "type": "float | None", + "description": "Policyholder funds.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reinsurance_balances_payable", + "type": "float | None", + "description": "Reinsurance balances payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt", + "type": "float | None", + "description": "Long term debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_capital_lease_obligation", + "type": "float | None", + "description": "Long term capital lease obligation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt_and_capital_lease_obligation", + "type": "float | None", + "description": "Long term debt and capital lease obligation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_provisions", + "type": "float | None", + "description": "Long term provisions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_accrued_expenses", + "type": "float | None", + "description": "Non current accrued expenses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_deferred_revenue", + "type": "float | None", + "description": "Non current deferred revenue.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_deferred_liabilities", + "type": "float | None", + "description": "Non current deferred liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_deferred_taxes_liabilities", + "type": "float | None", + "description": "Non current deferred taxes liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employee_benefits", + "type": "float | None", + "description": "Employee benefits.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "defined_pension_benefit", + "type": "float | None", + "description": "Defined pension benefit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minimum_pension_liabilities", + "type": "float | None", + "description": "Minimum pension liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_current_pension_and_other_postretirement_benefit_plans", + "type": "float | None", + "description": "Non current pension and other postretirement benefit plans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "regulatory_liabilities", + "type": "float | None", + "description": "Regulatory liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_deferred_credits_and_other_non_current_liabilities", + "type": "float | None", + "description": "Total deferred credits and other non current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trust_preferred_securities", + "type": "float | None", + "description": "Trust preferred securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_liabilities", + "type": "float | None", + "description": "Other liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_current_liabilities", + "type": "float | None", + "description": "Other non current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_non_current_liabilities", + "type": "float | None", + "description": "Total non current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_non_current_liabilities_net_minority_interest", + "type": "float | None", + "description": "Total non current liabilities net minority interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_liabilities", + "type": "float | None", + "description": "Total liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_stock", + "type": "float | None", + "description": "Preferred stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stock", + "type": "float | None", + "description": "Common stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_stock", + "type": "float | None", + "description": "Capital stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_capital_stock", + "type": "float | None", + "description": "Other capital stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "additional_paid_in_capital", + "type": "float | None", + "description": "Additional paid in capital.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "treasury_stock", + "type": "float | None", + "description": "Treasury stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "retained_earnings", + "type": "float | None", + "description": "Retained earnings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gains_losses_not_affecting_retained_earnings", + "type": "float | None", + "description": "Gains losses not affecting retained earnings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_unrealized_gain_loss_investments", + "type": "float | None", + "description": "Net unrealized gain loss investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_unrealized_gain_loss_foreign_currency", + "type": "float | None", + "description": "Net unrealized gain loss foreign currency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_other_unrealized_gain_loss", + "type": "float | None", + "description": "Net other unrealized gain loss.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unrealized_gain_loss", + "type": "float | None", + "description": "Unrealized gain loss.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_equity_adjustments", + "type": "float | None", + "description": "Other equity adjustments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_equity_interest", + "type": "float | None", + "description": "Other equity interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stock_equity", + "type": "float | None", + "description": "Common stock equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minority_interest", + "type": "float | None", + "description": "Minority interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stockholders_equity", + "type": "float | None", + "description": "Stockholders equity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_equity_gross_minority", + "type": "float | None", + "description": "Total equity gross minority.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_equity_gross_minority_interest", + "type": "float | None", + "description": "Total equity gross minority interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_liabilities_and_total_equity_gross_minority_interest", + "type": "float | None", + "description": "Total liabilities and total equity gross minority interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_capitalization", + "type": "float | None", + "description": "Total capitalization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "working_capital", + "type": "float | None", + "description": "Working capital.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_employees", + "type": "int | None", + "description": "Total employees.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxBalanceSheet", + "openapi_extra": { + "widget_config": { + "data": { + "table": { + "transpose": true + } + } + }, + "model": "TmxBalanceSheet" + } + }, + "/tmx/equity/fundamental/cash": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Cash flow statement, annual or quarterly.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Cash flow statement.\nobb.tmx.equity.fundamental.cash(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of periods to return. Every published period when not supplied.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarter", + "value": "quarter" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxCashFlowStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "reported_currency", + "type": "str | None", + "description": "The currency the statement is reported in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_income_from_continuing_operations", + "type": "float | None", + "description": "Net income from continuing operations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation", + "type": "float | None", + "description": "Depreciation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization", + "type": "float | None", + "description": "Amortization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amortization_of_intangibles", + "type": "float | None", + "description": "Amortization of intangibles.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depletion", + "type": "float | None", + "description": "Depletion.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_and_amortization", + "type": "float | None", + "description": "Depreciation and amortization.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "depreciation_amortization_depletion", + "type": "float | None", + "description": "Depreciation amortization depletion.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_based_compensation", + "type": "float | None", + "description": "Stock based compensation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_tax", + "type": "float | None", + "description": "Deferred tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "deferred_income_tax", + "type": "float | None", + "description": "Deferred income tax.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_impairment_charge", + "type": "float | None", + "description": "Asset impairment charge.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "provision_for_loan_lease_and_other_losses", + "type": "float | None", + "description": "Provision for loan lease and other losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pension_and_employee_benefit_expense", + "type": "float | None", + "description": "Pension and employee benefit expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_gains_losses", + "type": "float | None", + "description": "Operating gains losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_losses_from_equity_investments", + "type": "float | None", + "description": "Earnings losses from equity investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_loss_on_investment_securities", + "type": "float | None", + "description": "Gain loss on investment securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_loss_on_sale_of_business", + "type": "float | None", + "description": "Gain loss on sale of business.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gain_loss_on_sale_of_ppe", + "type": "float | None", + "description": "Gain loss on sale of property, plant and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unrealized_gain_loss_on_investment_securities", + "type": "float | None", + "description": "Unrealized gain loss on investment securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unrealized_gains_losses_on_derivatives", + "type": "float | None", + "description": "Unrealized gains losses on derivatives.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_foreign_currency_exchange_gain_loss", + "type": "float | None", + "description": "Net foreign currency exchange gain loss.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "other_non_cash_items", + "type": "float | None", + "description": "Other non cash items.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_receivables", + "type": "float | None", + "description": "Change in receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "changes_in_account_receivables", + "type": "float | None", + "description": "Changes in account receivables.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_inventory", + "type": "float | None", + "description": "Change in inventory.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_prepaid_assets", + "type": "float | None", + "description": "Change in prepaid assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_payable", + "type": "float | None", + "description": "Change in payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_account_payable", + "type": "float | None", + "description": "Change in account payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_accrued_expense", + "type": "float | None", + "description": "Change in accrued expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_payables_and_accrued_expense", + "type": "float | None", + "description": "Change in payables and accrued expense.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_tax_payable", + "type": "float | None", + "description": "Change in tax payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_income_tax_payable", + "type": "float | None", + "description": "Change in income tax payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_interest_payable", + "type": "float | None", + "description": "Change in interest payable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_current_assets", + "type": "float | None", + "description": "Change in other current assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_current_liabilities", + "type": "float | None", + "description": "Change in other current liabilities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_other_working_capital", + "type": "float | None", + "description": "Change in other working capital.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_working_capital", + "type": "float | None", + "description": "Change in working capital.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_loans", + "type": "float | None", + "description": "Change in loans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_trading_account_securities", + "type": "float | None", + "description": "Change in trading account securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_deferred_acquisition_costs", + "type": "float | None", + "description": "Change in deferred acquisition costs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_premiums_receivable", + "type": "float | None", + "description": "Change in premiums receivable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_unearned_premiums", + "type": "float | None", + "description": "Change in unearned premiums.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_loss_and_loss_adjustment_expense_reserves", + "type": "float | None", + "description": "Change in loss and loss adjustment expense reserves.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_reinsurance_recoverable_on_paid_and_unpaid_losses", + "type": "float | None", + "description": "Change in reinsurance recoverable on paid and unpaid losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_in_reinsurance_recoverable_on_unpaid_losses", + "type": "float | None", + "description": "Change in reinsurance recoverable on unpaid losses.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "increase_decrease_in_deposit", + "type": "float | None", + "description": "Increase decrease in deposit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_flow_from_continuing_operating_activities", + "type": "float | None", + "description": "Cash flow from continuing operating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_from_discontinued_operating_activities", + "type": "float | None", + "description": "Cash from discontinued operating activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "operating_cash_flow", + "type": "float | None", + "description": "Operating cash flow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_expenditure", + "type": "float | None", + "description": "Capital expenditure.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "capital_expenditure_reported", + "type": "float | None", + "description": "Capital expenditure reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_ppe", + "type": "float | None", + "description": "Purchase of property, plant and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_ppe", + "type": "float | None", + "description": "Sale of property, plant and equipment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_ppe_purchase_and_sale", + "type": "float | None", + "description": "Net property, plant and equipment purchase and sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_capital_expenditure_disposals", + "type": "float | None", + "description": "Net capital expenditure disposals.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_business", + "type": "float | None", + "description": "Purchase of business.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_business", + "type": "float | None", + "description": "Sale of business.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_business_purchase_and_sale", + "type": "float | None", + "description": "Net business purchase and sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_intangibles", + "type": "float | None", + "description": "Purchase of intangibles.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_intangibles_purchase_and_sale", + "type": "float | None", + "description": "Net intangibles purchase and sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_investment", + "type": "float | None", + "description": "Purchase of investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_investment", + "type": "float | None", + "description": "Sale of investment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_short_term_investments", + "type": "float | None", + "description": "Purchase of short term investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_short_term_investments", + "type": "float | None", + "description": "Sale of short term investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_long_term_investments", + "type": "float | None", + "description": "Purchase of long term investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sale_of_long_term_investments", + "type": "float | None", + "description": "Sale of long term investments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purchase_of_fixed_maturity_securities", + "type": "float | None", + "description": "Purchase of fixed maturity securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_of_fixed_maturity_securities", + "type": "float | None", + "description": "Sales of fixed maturity securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "calls_maturities_of_maturity_securities", + "type": "float | None", + "description": "Calls maturities of maturity securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_investment_purchase_and_sale", + "type": "float | None", + "description": "Net investment purchase and sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_investment_properties_purchase_and_sale", + "type": "float | None", + "description": "Net investment properties purchase and sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payment_for_loans", + "type": "float | None", + "description": "Payment for loans.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_proceeds_payment_for_loan", + "type": "float | None", + "description": "Net proceeds payment for loan.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "proceeds_payment_in_interest_bearing_deposits_in_bank", + "type": "float | None", + "description": "Proceeds payment in interest bearing deposits in bank.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_other_investing_changes", + "type": "float | None", + "description": "Net other investing changes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_flow_from_continuing_investing_activities", + "type": "float | None", + "description": "Cash flow from continuing investing activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_from_discontinued_investing_activities", + "type": "float | None", + "description": "Cash from discontinued investing activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investing_cash_flow", + "type": "float | None", + "description": "Investing cash flow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuance_of_debt", + "type": "float | None", + "description": "Issuance of debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "repayment_of_debt", + "type": "float | None", + "description": "Repayment of debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_debt_issuance", + "type": "float | None", + "description": "Short term debt issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_term_debt_payments", + "type": "float | None", + "description": "Short term debt payments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_short_term_debt_issuance", + "type": "float | None", + "description": "Net short term debt issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt_issuance", + "type": "float | None", + "description": "Long term debt issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_term_debt_payments", + "type": "float | None", + "description": "Long term debt payments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_long_term_debt_issuance", + "type": "float | None", + "description": "Net long term debt issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_issuance_payments_of_debt", + "type": "float | None", + "description": "Net issuance payments of debt.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stock_issuance", + "type": "float | None", + "description": "Common stock issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuance_of_capital_stock", + "type": "float | None", + "description": "Issuance of capital stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stock_payments", + "type": "float | None", + "description": "Common stock payments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "repurchase_of_capital_stock", + "type": "float | None", + "description": "Repurchase of capital stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_common_stock_issuance", + "type": "float | None", + "description": "Net common stock issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "proceeds_from_stock_option_exercised", + "type": "float | None", + "description": "Proceeds from stock option exercised.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_stock_issuance", + "type": "float | None", + "description": "Preferred stock issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_stock_payments", + "type": "float | None", + "description": "Preferred stock payments.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_preferred_stock_issuance", + "type": "float | None", + "description": "Net preferred stock issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_dividends_paid", + "type": "float | None", + "description": "Cash dividends paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "common_stock_dividend_paid", + "type": "float | None", + "description": "Common stock dividend paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "preferred_stock_dividend_paid", + "type": "float | None", + "description": "Preferred stock dividend paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_other_financing_charges", + "type": "float | None", + "description": "Net other financing charges.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_flow_from_continuing_financing_activities", + "type": "float | None", + "description": "Cash flow from continuing financing activities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "financing_cash_flow", + "type": "float | None", + "description": "Financing cash flow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "effect_of_exchange_rate_changes", + "type": "float | None", + "description": "Effect of exchange rate changes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "changes_in_cash", + "type": "float | None", + "description": "Changes in cash.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "beginning_cash_position", + "type": "float | None", + "description": "Beginning cash position.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "end_cash_position", + "type": "float | None", + "description": "End cash position.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "free_cash_flow", + "type": "float | None", + "description": "Free cash flow.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "income_tax_paid_supplemental_data", + "type": "float | None", + "description": "Income tax paid supplemental data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_paid_supplemental_data", + "type": "float | None", + "description": "Interest paid supplemental data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxCashFlowStatement", + "openapi_extra": { + "widget_config": { + "data": { + "table": { + "transpose": true + } + } + }, + "model": "TmxCashFlowStatement" + } + }, + "/tmx/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return declared dividends, with ex, record, and payable dates.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Declared dividend history.\nobb.tmx.equity.fundamental.dividends(symbol='BNS', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxHistoricalDividends", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "currency", + "type": "str | None", + "description": "The currency the dividend is paid in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "declaration_date", + "type": "date | None", + "description": "The date of the announcement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "record_date", + "type": "date | None", + "description": "The record date of ownership for rights to the dividend.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "payment_date", + "type": "date | None", + "description": "The date the dividend is paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxHistoricalDividends", + "openapi_extra": { + "model": "TmxHistoricalDividends" + } + }, + "/tmx/equity/fundamental/splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical share splits.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Share split history.\nobb.tmx.equity.fundamental.splits(symbol='BNS', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxHistoricalSplits", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "numerator", + "type": "float | None", + "description": "Numerator of the split.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "denominator", + "type": "float | None", + "description": "Denominator of the split.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "split_ratio", + "type": "str | None", + "description": "Split ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "ratio", + "type": "float | None", + "description": "The split ratio, as published.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxHistoricalSplits", + "openapi_extra": { + "model": "TmxHistoricalSplits" + } + }, + "/tmx/equity/fundamental/income_view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the income statement, a column per reported period.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AC", + "optional": true + }, + { + "name": "period", + "type": "str", + "description": "", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "", + "default": 10, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Income Statement", + "description": "The income statement, a column per reported period.", + "category": "Equity", + "subCategory": "Fundamental", + "widgetId": "tmx_equity_fundamental_income_view_obb", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 20 + }, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AC", + "description": "The company to report on." + }, + { + "paramName": "period", + "label": "Period", + "value": "annual", + "description": "Annual or quarterly reports.", + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarter", + "value": "quarter" + } + ] + }, + { + "paramName": "limit", + "label": "Periods", + "value": 10, + "description": "How many periods to report, newest first." + }, + { + "paramName": "use_cache", + "label": "Use Cache", + "value": true + } + ] + } + } + }, + "/tmx/equity/fundamental/balance_view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the balance sheet, a column per reported period.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AC", + "optional": true + }, + { + "name": "period", + "type": "str", + "description": "", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "", + "default": 10, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Balance Sheet", + "description": "The balance statement, a column per reported period.", + "category": "Equity", + "subCategory": "Fundamental", + "widgetId": "tmx_equity_fundamental_balance_view_obb", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 20 + }, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AC", + "description": "The company to report on." + }, + { + "paramName": "period", + "label": "Period", + "value": "annual", + "description": "Annual or quarterly reports.", + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarter", + "value": "quarter" + } + ] + }, + { + "paramName": "limit", + "label": "Periods", + "value": 10, + "description": "How many periods to report, newest first." + }, + { + "paramName": "use_cache", + "label": "Use Cache", + "value": true + } + ] + } + } + }, + "/tmx/equity/fundamental/cash_view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the cash flow statement, a column per reported period.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AC", + "optional": true + }, + { + "name": "period", + "type": "str", + "description": "", + "default": "annual", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "", + "default": 10, + "optional": true + }, + { + "name": "use_cache", + "type": "bool", + "description": "", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Cash Flow Statement", + "description": "The cash statement, a column per reported period.", + "category": "Equity", + "subCategory": "Fundamental", + "widgetId": "tmx_equity_fundamental_cash_view_obb", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 20 + }, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AC", + "description": "The company to report on." + }, + { + "paramName": "period", + "label": "Period", + "value": "annual", + "description": "Annual or quarterly reports.", + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarter", + "value": "quarter" + } + ] + }, + { + "paramName": "limit", + "label": "Periods", + "value": 10, + "description": "How many periods to report, newest first." + }, + { + "paramName": "use_cache", + "label": "Use Cache", + "value": true + } + ] + } + } + }, + "/tmx/equity/calendar/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Earnings calendar, with estimated and actual EPS.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Earnings calendar with estimates.\nobb.tmx.equity.calendar.earnings(provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxCalendarEarnings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_previous", + "type": "float | None", + "description": "The earnings-per-share from the same previously reported period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_consensus", + "type": "float | None", + "description": "The analyst conesus earnings-per-share estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "name", + "type": "str", + "description": "The company's name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eps_consensus", + "type": "float | None", + "description": "The consensus estimated EPS in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_actual", + "type": "float | None", + "description": "The actual EPS in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_surprise", + "type": "float | None", + "description": "The EPS surprise in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "surprise_percent", + "type": "float | None", + "description": "The EPS surprise as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "reporting_time", + "type": "str | None", + "description": "The time of the report - i.e., before or after market.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxCalendarEarnings", + "openapi_extra": { + "model": "TmxCalendarEarnings" + } + }, + "/tmx/equity/ownership/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Insider buying and selling activity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Insider activity summary.\nobb.tmx.equity.ownership.insider_trading(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "summary", + "type": "bool | None", + "description": "Return a summary of the insider activity instead of the individuals.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxInsiderTrading", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_cik", + "type": "str | None", + "description": "CIK number of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | datetime | None", + "description": "Filing date of the trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_date", + "type": "date | None", + "description": "Date of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_cik", + "type": "int | str | None", + "description": "Reporting individual's CIK.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_name", + "type": "str | None", + "description": "Name of the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_title", + "type": "str | None", + "description": "The title held by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ownership_type", + "type": "str | None", + "description": "Type of ownership, e.g., direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type", + "type": "str | None", + "description": "Type of transaction being reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acquisition_or_disposition", + "type": "str | None", + "description": "Acquisition or disposition of the shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The type of security transacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_owned", + "type": "float | None", + "description": "Number of securities owned by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_transacted", + "type": "float | None", + "description": "Number of securities transacted by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_price", + "type": "float | None", + "description": "The price of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_url", + "type": "str | None", + "description": "Link to the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "owner_name", + "type": "str | None", + "description": "The name of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_owned", + "type": "int | None", + "description": "The number of shares held by the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_transacted", + "type": "int | None", + "description": "The total number of shares traded by the insider over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The period of the activity. Bucketed by three, six, and twelve months.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "acquisition_or_deposition", + "type": "str | None", + "description": "Whether the insider bought or sold the shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_trades", + "type": "int | None", + "description": "The number of shares traded over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_value", + "type": "float | None", + "description": "The value of the shares traded by the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_bought", + "type": "int | None", + "description": "The total number of shares bought by all insiders over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_sold", + "type": "int | None", + "description": "The total number of shares sold by all insiders over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_activity", + "type": "int | None", + "description": "The total net activity by all insiders over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxInsiderTrading", + "openapi_extra": { + "model": "TmxInsiderTrading" + } + }, + "/tmx/equity/ownership/insider_transactions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Individual insider filings, as reported to SEDI.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every insider filing over the past year.\nobb.tmx.equity.ownership.insider_transactions(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "The company symbol.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str | None", + "description": "How far back to read filings.", + "default": "12m", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "3 Months", + "value": "3m" + }, + { + "label": "6 Months", + "value": "6m" + }, + { + "label": "1 Year", + "value": "12m" + }, + { + "label": "2 Years", + "value": "24m" + }, + { + "label": "3 Years", + "value": "36m" + }, + { + "label": "5 Years", + "value": "60m" + }, + { + "label": "10 Years", + "value": "120m" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. Filings are cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxInsiderTransactions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "owner_name", + "type": "str | None", + "description": "The name of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "relationship", + "type": "str | None", + "description": "The insider's relationship to the issuer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_date", + "type": "date | None", + "description": "The date of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | None", + "description": "The date the transaction was filed to SEDI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type", + "type": "str | None", + "description": "The nature of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type_code", + "type": "int | None", + "description": "The SEDI code for the nature of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_transacted", + "type": "float | None", + "description": "The number of securities transacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_owned", + "type": "float | None", + "description": "The number of securities held after the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ownership_type", + "type": "str | None", + "description": "Whether the holding is direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price the securities were transacted at.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_value", + "type": "float | None", + "description": "The value of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The designation of the security transacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_security_type", + "type": "str | None", + "description": "The designation of the underlying security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_shares", + "type": "float | None", + "description": "The number of underlying shares represented.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "insider_since", + "type": "date | None", + "description": "The date the filer became an insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_id", + "type": "int | None", + "description": "The SEDI transaction ID.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_number", + "type": "str | None", + "description": "The SEDI issuer number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "insider_number", + "type": "str | None", + "description": "The SEDI insider number.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxInsiderTransactions", + "openapi_extra": { + "widget_config": { + "name": "TMX Insider Transactions", + "description": "Individual insider filings published to SEDI.", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 15 + } + }, + "model": "TmxInsiderTransactions" + } + }, + "/tmx/equity/estimates/consensus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Analyst consensus, ratings breakdown, and price targets.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Analyst consensus and price targets.\nobb.tmx.equity.estimates.consensus(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + } + ], + "tmx": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxPriceTargetConsensus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The company name", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_high", + "type": "float | None", + "description": "High target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_low", + "type": "float | None", + "description": "Low target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_consensus", + "type": "float | None", + "description": "Consensus target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_median", + "type": "float | None", + "description": "Median target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "target_upside", + "type": "float | None", + "description": "Percent of upside, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "total_analysts", + "type": "int | None", + "description": "Total number of analyst.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "buy_ratings", + "type": "int | None", + "description": "Number of buy ratings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sell_ratings", + "type": "int | None", + "description": "Number of sell ratings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hold_ratings", + "type": "int | None", + "description": "Number of hold ratings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus_action", + "type": "str | None", + "description": "Consensus action.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxPriceTargetConsensus", + "openapi_extra": { + "model": "TmxPriceTargetConsensus" + } + }, + "/tmx/etf/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the TMX-listed ETF universe.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the listed ETF universe.\nobb.tmx.etf.search(provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "div_freq", + "type": "str | None", + "description": "The dividend payment frequency.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Monthly", + "value": "monthly" + }, + { + "label": "Quarterly", + "value": "quarterly" + }, + { + "label": "Annually", + "value": "annually" + }, + { + "label": "Semi-Annually", + "value": "semi-annually" + }, + { + "label": "Unspecified", + "value": "unspecified" + } + ] + } + } + }, + { + "name": "asset_class", + "type": "str | None", + "description": "Filter by asset class.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Equity", + "value": "equity" + }, + { + "label": "Fixed Income", + "value": "fixed_income" + }, + { + "label": "Single Stock ETF", + "value": "single_stock_etf" + }, + { + "label": "Asset Allocation", + "value": "asset_allocation" + }, + { + "label": "Cryptocurrency", + "value": "cryptocurrency" + }, + { + "label": "Alternative", + "value": "alternative" + }, + { + "label": "Leverage/Inverse", + "value": "leverage_inverse" + }, + { + "label": "Commodity", + "value": "commodity" + }, + { + "label": "Cash/Currency", + "value": "cash_currency" + }, + { + "label": "Preferred Share", + "value": "preferred_share" + } + ] + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "Filter by region.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "United States", + "value": "united_states" + }, + { + "label": "Canada", + "value": "canada" + }, + { + "label": "Global", + "value": "global" + }, + { + "label": "North America", + "value": "north_america" + }, + { + "label": "International", + "value": "international" + }, + { + "label": "Emerging Markets", + "value": "emerging_markets" + }, + { + "label": "Europe", + "value": "europe" + }, + { + "label": "Asia", + "value": "asia" + }, + { + "label": "Australia", + "value": "australia" + } + ] + } + } + }, + { + "name": "fund_family", + "type": "str | None", + "description": "Filter by fund family.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "RBC iShares", + "value": "rbc_ishares" + }, + { + "label": "BMO ETF", + "value": "bmo_etf" + }, + { + "label": "Global X", + "value": "global_x" + }, + { + "label": "CI Global Asset Management", + "value": "ci_global_asset_management" + }, + { + "label": "Harvest ETFs", + "value": "harvest_etfs" + }, + { + "label": "Evolve ETFs", + "value": "evolve_etfs" + }, + { + "label": "Purpose Investments", + "value": "purpose_investments" + }, + { + "label": "TD ETFs", + "value": "td_etfs" + }, + { + "label": "Invesco Canada", + "value": "invesco_canada" + }, + { + "label": "Mackenzie Investments", + "value": "mackenzie_investments" + }, + { + "label": "National Bank Investments", + "value": "national_bank_investments" + }, + { + "label": "Fidelity Investments Canada ULC", + "value": "fidelity_investments_canada_ulc" + }, + { + "label": "CIBC ETF", + "value": "cibc_etf" + }, + { + "label": "LongPoint ETFs", + "value": "longpoint_etfs" + }, + { + "label": "Vanguard Canada", + "value": "vanguard_canada" + }, + { + "label": "Hamilton ETFs", + "value": "hamilton_etfs" + }, + { + "label": "Ninepoint Partners", + "value": "ninepoint_partners" + }, + { + "label": "BetaPro ETFs", + "value": "betapro_etfs" + }, + { + "label": "Dynamic", + "value": "dynamic" + }, + { + "label": "Desjardins", + "value": "desjardins" + }, + { + "label": "Manulife", + "value": "manulife" + }, + { + "label": "Brompton Funds", + "value": "brompton_funds" + }, + { + "label": "First Trust Portfolios Canada", + "value": "first_trust_portfolios_canada" + }, + { + "label": "Guardian Capital", + "value": "guardian_capital" + }, + { + "label": "Franklin Templeton", + "value": "franklin_templeton" + }, + { + "label": "J.P. Morgan Asset Management", + "value": "j_p_morgan_asset_management" + }, + { + "label": "IA Clarington", + "value": "ia_clarington" + }, + { + "label": "Picton Investments", + "value": "picton_investments" + }, + { + "label": "PIMCO Canada Trust", + "value": "pimco_canada_trust" + }, + { + "label": "Russell Investments", + "value": "russell_investments" + }, + { + "label": "3iQ", + "value": "3iq" + }, + { + "label": "Accelerate", + "value": "accelerate" + }, + { + "label": "Middlefield ETFs", + "value": "middlefield_etfs" + }, + { + "label": "Capital Group", + "value": "capital_group" + }, + { + "label": "Mulvihill Capital Markets", + "value": "mulvihill_capital_markets" + }, + { + "label": "Arrow Capital Management", + "value": "arrow_capital_management" + }, + { + "label": "Sun Life Global Investments", + "value": "sun_life_global_investments" + }, + { + "label": "AGF Investments Inc.", + "value": "agf_investments_inc" + }, + { + "label": "Lysander Funds", + "value": "lysander_funds" + }, + { + "label": "Royal Canadian Mint", + "value": "royal_canadian_mint" + }, + { + "label": "Trading Central Canada Inc.", + "value": "trading_central_canada_inc" + }, + { + "label": "Bristol Gate", + "value": "bristol_gate" + }, + { + "label": "Forstrong Global Asset Management", + "value": "forstrong_global_asset_management" + }, + { + "label": "Humilis Investment Strategies", + "value": "humilis_investment_strategies" + }, + { + "label": "Capstone Asset Management", + "value": "capstone_asset_management" + }, + { + "label": "Madison Investments", + "value": "madison_investments" + }, + { + "label": "Return Stacked ETFs", + "value": "return_stacked_etfs" + }, + { + "label": "TRU.X", + "value": "tru_x" + }, + { + "label": "Wealthsimple", + "value": "wealthsimple" + }, + { + "label": "Caldwell Investment", + "value": "caldwell_investment" + }, + { + "label": "Corton Capital", + "value": "corton_capital" + }, + { + "label": "Evovest", + "value": "evovest" + }, + { + "label": "Lightwater Partners", + "value": "lightwater_partners" + }, + { + "label": "MOAT Financial", + "value": "moat_financial" + }, + { + "label": "Quadravest Capital Management", + "value": "quadravest_capital_management" + }, + { + "label": "ROCKLINC", + "value": "rocklinc" + }, + { + "label": "Tralucent Asset Management", + "value": "tralucent_asset_management" + } + ] + } + } + }, + { + "name": "investment_style", + "type": "str | None", + "description": "Filter by investment style.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Large Cap Blend", + "value": "large_cap_blend" + }, + { + "label": "Multi Alternative", + "value": "multi_alternative" + }, + { + "label": "Large Cap Growth", + "value": "large_cap_growth" + }, + { + "label": "Large Cap Value", + "value": "large_cap_value" + }, + { + "label": "Option Writing", + "value": "option_writing" + }, + { + "label": "Long Term High Quality", + "value": "long_term_high_quality" + }, + { + "label": "Investment Grade Bond", + "value": "investment_grade_bond" + }, + { + "label": "Mid Cap Growth", + "value": "mid_cap_growth" + }, + { + "label": "Allocation/Balanced", + "value": "allocation_balanced" + }, + { + "label": "Long Term Mid Quality", + "value": "long_term_mid_quality" + }, + { + "label": "Short Term High Quality", + "value": "short_term_high_quality" + }, + { + "label": "All Cap Blend", + "value": "all_cap_blend" + }, + { + "label": "Leverage Strategy", + "value": "leverage_strategy" + }, + { + "label": "Mid Cap Blend", + "value": "mid_cap_blend" + }, + { + "label": "Mid Cap Value", + "value": "mid_cap_value" + }, + { + "label": "Ultra short- Low risk", + "value": "ultra_short_low_risk" + }, + { + "label": "Short Term Mid Quality", + "value": "short_term_mid_quality" + }, + { + "label": "Intermediate Term High Quality", + "value": "intermediate_term_high_quality" + }, + { + "label": "Trading-Leveraged Equity", + "value": "trading_leveraged_equity" + }, + { + "label": "Equity-oriented Balanced", + "value": "equity_oriented_balanced" + }, + { + "label": "Intermediate Term Mid Quality", + "value": "intermediate_term_mid_quality" + }, + { + "label": "Debt-oriented balanced", + "value": "debt_oriented_balanced" + }, + { + "label": "Preferred Stock", + "value": "preferred_stock" + }, + { + "label": "Small Cap Blend", + "value": "small_cap_blend" + }, + { + "label": "Gold", + "value": "gold" + }, + { + "label": "High Yield Bond", + "value": "high_yield_bond" + }, + { + "label": "Small Cap Growth", + "value": "small_cap_growth" + }, + { + "label": "Long Term Bond", + "value": "long_term_bond" + }, + { + "label": "Long Term Government Bond", + "value": "long_term_government_bond" + }, + { + "label": "Trading-Inverse Equity", + "value": "trading_inverse_equity" + }, + { + "label": "Intermediate Term Low Quality", + "value": "intermediate_term_low_quality" + }, + { + "label": "Long Term Low Quality", + "value": "long_term_low_quality" + }, + { + "label": "Long-Short Strategy", + "value": "long_short_strategy" + }, + { + "label": "Small Cap Value", + "value": "small_cap_value" + }, + { + "label": "Tactical Allocation", + "value": "tactical_allocation" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Multicurrency", + "value": "multicurrency" + }, + { + "label": "Short Term Government Bond", + "value": "short_term_government_bond" + }, + { + "label": "Ultrashort Term Bond", + "value": "ultrashort_term_bond" + }, + { + "label": "Intermediate Term Bond", + "value": "intermediate_term_bond" + }, + { + "label": "Short Term Bond", + "value": "short_term_bond" + }, + { + "label": "Silver", + "value": "silver" + }, + { + "label": "Miscellaneous", + "value": "miscellaneous" + }, + { + "label": "Precious Metals", + "value": "precious_metals" + }, + { + "label": "Short Term Low Quality", + "value": "short_term_low_quality" + }, + { + "label": "Bank Loan", + "value": "bank_loan" + }, + { + "label": "Intermediate Term Diversified Sectoral Bond", + "value": "intermediate_term_diversified_sectoral_bond" + }, + { + "label": "Intermediate Term Government Bond", + "value": "intermediate_term_government_bond" + }, + { + "label": "Long Term High Yield Bond", + "value": "long_term_high_yield_bond" + }, + { + "label": "Commodities", + "value": "commodities" + }, + { + "label": "Global Diversified Sectoral Bond", + "value": "global_diversified_sectoral_bond" + }, + { + "label": "Investment Grade Government Bond", + "value": "investment_grade_government_bond" + }, + { + "label": "Trading-Leveraged Commodities", + "value": "trading_leveraged_commodities" + }, + { + "label": "Trading-Leveraged Miscellaneous", + "value": "trading_leveraged_miscellaneous" + }, + { + "label": "Equity Tactical Allocation", + "value": "equity_tactical_allocation" + }, + { + "label": "Fixed Income Tactical Allocation", + "value": "fixed_income_tactical_allocation" + }, + { + "label": "Single Currency", + "value": "single_currency" + }, + { + "label": "Volatility/ Derivative Strategy", + "value": "volatility_derivative_strategy" + }, + { + "label": "Agriculture", + "value": "agriculture" + }, + { + "label": "Short Term High Yield Bond", + "value": "short_term_high_yield_bond" + }, + { + "label": "Short Term Investment Grade Bond", + "value": "short_term_investment_grade_bond" + } + ] + } + } + }, + { + "name": "currency", + "type": "str | None", + "description": "Filter by the currency the fund trades in.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Canadian Dollar", + "value": "CAD" + }, + { + "label": "US Dollar", + "value": "USD" + } + ] + } + } + }, + { + "name": "esg", + "type": "bool | None", + "description": "Restrict to funds flagged as ESG.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort_by", + "type": "str | None", + "description": "The column to sort by.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "AUM", + "value": "aum" + }, + { + "label": "Return 1M", + "value": "return_1m" + }, + { + "label": "Return 3M", + "value": "return_3m" + }, + { + "label": "Return 6M", + "value": "return_6m" + }, + { + "label": "Return 1Y", + "value": "return_1y" + }, + { + "label": "Return 3Y", + "value": "return_3y" + }, + { + "label": "Return YTD", + "value": "return_ytd" + }, + { + "label": "Beta 1Y", + "value": "beta_1y" + }, + { + "label": "Average Daily Volume", + "value": "volume_avg_daily" + }, + { + "label": "Management Fee", + "value": "management_fee" + }, + { + "label": "Distribution Yield", + "value": "distribution_yield" + }, + { + "label": "P/B Ratio", + "value": "pb_ratio" + }, + { + "label": "P/E Ratio", + "value": "pe_ratio" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEtfSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.(ETF)", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "short_name", + "type": "str | None", + "description": "The short name of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inception_date", + "type": "str | None", + "description": "The inception date of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "The issuer of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_style", + "type": "str | None", + "description": "The investment style of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "esg", + "type": "bool | None", + "description": "Whether the ETF qualifies as an ESG fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit_price", + "type": "float | None", + "description": "The unit price of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The closing price of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous closing price of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_1m", + "type": "float | None", + "description": "The one-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_3m", + "type": "float | None", + "description": "The three-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_6m", + "type": "float | None", + "description": "The six-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_ytd", + "type": "float | None", + "description": "The year-to-date return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_1y", + "type": "float | None", + "description": "The one-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta_1y", + "type": "float | None", + "description": "The one-year beta of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_3y", + "type": "float | None", + "description": "The three-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta_3y", + "type": "float | None", + "description": "The three-year beta of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_5y", + "type": "float | None", + "description": "The five-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta_5y", + "type": "float | None", + "description": "The five-year beta of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_10y", + "type": "float | None", + "description": "The ten-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta_10y", + "type": "float | None", + "description": "The ten-year beta of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "beta_15y", + "type": "float | None", + "description": "The fifteen-year beta of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_from_inception", + "type": "float | None", + "description": "The return from inception of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "avg_volume", + "type": "int | None", + "description": "The average daily volume of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "avg_volume_30d", + "type": "int | None", + "description": "The 30-day average volume of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "aum", + "type": "float | None", + "description": "The AUM of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pe_ratio", + "type": "float | None", + "description": "The price-to-earnings ratio of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pb_ratio", + "type": "float | None", + "description": "The price-to-book ratio of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "management_fee", + "type": "float | None", + "description": "The management fee of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "mer", + "type": "float | None", + "description": "The management expense ratio of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "distribution_yield", + "type": "float | None", + "description": "The distribution yield of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "dividend_frequency", + "type": "str | None", + "description": "The dividend payment frequency of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEtfSearch", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "description": "The symbol a click on the search results selects.", + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "TmxEtfSearch" + } + }, + "/tmx/etf/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Fund profile, fees, and reference data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fund profile and reference data.\nobb.tmx.etf.info(symbol='XIU', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEtfInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "Issuer of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "domicile", + "type": "str | None", + "description": "Domicile of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "Website of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inception_date", + "type": "date | None", + "description": "Inception date of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "issuer", + "type": "str | None", + "description": "The issuer of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "The website of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The description of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "investment_style", + "type": "str | None", + "description": "The investment style of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The asset class of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "region", + "type": "str | None", + "description": "The region the ETF invests in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "index_fund", + "type": "str | None", + "description": "Whether the ETF tracks an index or is actively managed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "esg", + "type": "bool | None", + "description": "Whether the ETF qualifies as an ESG fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str", + "description": "The currency of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "unit_price", + "type": "float | None", + "description": "The unit price of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The closing price of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous closing price of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_1m", + "type": "float | None", + "description": "The one-month return of the ETF, as a normalized percent", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_3m", + "type": "float | None", + "description": "The three-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_6m", + "type": "float | None", + "description": "The six-month return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_ytd", + "type": "float | None", + "description": "The year-to-date return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_1y", + "type": "float | None", + "description": "The one-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_3y", + "type": "float | None", + "description": "The three-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_5y", + "type": "float | None", + "description": "The five-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_10y", + "type": "float | None", + "description": "The ten-year return of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_from_inception", + "type": "float | None", + "description": "The return from inception of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "avg_volume", + "type": "int | None", + "description": "The average daily volume of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "avg_volume_30d", + "type": "int | None", + "description": "The 30-day average volume of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "aum", + "type": "float | None", + "description": "The AUM of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pe_ratio", + "type": "float | None", + "description": "The price-to-earnings ratio of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pb_ratio", + "type": "float | None", + "description": "The price-to-book ratio of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "management_fee", + "type": "float | None", + "description": "The management fee of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "mer", + "type": "float | None", + "description": "The management expense ratio of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "distribution_yield", + "type": "float | None", + "description": "The distribution yield of the ETF, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "dividend_frequency", + "type": "str | None", + "description": "The dividend payment frequency of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEtfInfo", + "openapi_extra": { + "model": "TmxEtfInfo" + } + }, + "/tmx/etf/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return the holdings of a TMX-listed fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Fund holdings.\nobb.tmx.etf.holdings(symbol='XIU', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. (ETF)", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEtfHoldings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "The weight of the asset in the portfolio, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "shares", + "type": "int | str | None", + "description": "The value of the assets under management.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_value", + "type": "float | str | None", + "description": "The market value of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "share_percentage", + "type": "float | None", + "description": "The share percentage of the holding, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "share_change", + "type": "float | str | None", + "description": "The change in shares of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The country of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange code of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "type_id", + "type": "str | None", + "description": "The holding type ID of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fund_id", + "type": "str | None", + "description": "The fund ID of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEtfHoldings", + "openapi_extra": { + "model": "TmxEtfHoldings" + } + }, + "/tmx/etf/sectors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sector exposure of a TMX-listed fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Sector weights.\nobb.tmx.etf.sectors(symbol='XIU', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEtfSectors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str", + "description": "Sector of exposure.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float", + "description": "Sector exposure for the ETF as a percent of total assets.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "tmx": [] + }, + "model": "TmxEtfSectors", + "openapi_extra": { + "model": "TmxEtfSectors" + } + }, + "/tmx/etf/countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Country exposure of a TMX-listed fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Country weights.\nobb.tmx.etf.countries(symbol='XIU', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEtfCountries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str", + "description": "The country of the exposure. Corresponding values are normalized percentage points.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float", + "description": "The net exposure of the ETF to the country as a percentage of the total ETF assets.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "tmx": [] + }, + "model": "TmxEtfCountries", + "openapi_extra": { + "model": "TmxEtfCountries" + } + }, + "/tmx/etf/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical prices for a TMX-listed fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily fund price history.\nobb.tmx.etf.historical(symbol='XIU', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022.", + "default": "day", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The adjustment factor to apply. Only valid for daily data.", + "default": "splits_only", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Splits Only", + "value": "splits_only" + }, + { + "label": "Splits and Dividends", + "value": "splits_and_dividends" + }, + { + "label": "Unadjusted", + "value": "unadjusted" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxEtfHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "high", + "type": "float | None", + "description": "The high price. The feed leaves it empty on a handful of historical foreign bars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price. The feed leaves it empty on a handful of historical foreign bars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume weighted average price for the day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price, as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "transactions", + "type": "int | None", + "description": "Total number of transactions recorded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transactions_value", + "type": "float | None", + "description": "Nominal value of recorded transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxEtfHistorical", + "openapi_extra": { + "widget_config": { + "name": "TMX Fund Historical Price", + "description": "Fund prices, charted over the TMX quote feed.", + "category": "Markets", + "type": "advanced_charting", + "endpoint": "api/v1/tmx/udf", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "defaultSymbol": "XIU", + "updateFrequency": 60000 + } + }, + "model": "TmxEtfHistorical" + } + }, + "/tmx/etf/fund_info/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the styled fund overview for the Workspace.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "XIU", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Fund Info", + "description": "A styled overview of the fund - session, performance, facts, classification, holdings, and weightings.", + "type": "iframe", + "category": "ETF", + "subCategory": "Profile", + "widgetId": "tmx_etf_fund_info_obb", + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "XIU", + "description": "The fund to describe." + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 20, + "h": 20 + }, + "refetchInterval": false, + "source": [ + "TMX" + ] + } + } + }, + "/tmx/index/available": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return the S&P/TSX index universe.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Every index TMX publishes.\nobb.tmx.index.available(provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxAvailableIndices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Stock exchange where the index is listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the index is traded in.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "TmxAvailableIndices", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "description": "The index a click on the list selects.", + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "TmxAvailableIndices" + } + }, + "/tmx/index/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Profile of an index, with links to its factsheet and methodology.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Index profile, documents, and key data.\nobb.tmx.index.info(symbol='^TSX', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIndexInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The name of the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The short description of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "methodology", + "type": "str | None", + "description": "URL to the methodology document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "factsheet", + "type": "str | None", + "description": "URL to the factsheet document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "num_constituents", + "type": "int | None", + "description": "The number of constituents in the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "last_updated", + "type": "str | None", + "description": "The timestamp of the last update to the index file.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_value", + "type": "float | None", + "description": "The total quoted market value of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "average_constituent_market_value", + "type": "float | None", + "description": "The average quoted market value of a constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "median_constituent_market_value", + "type": "float | None", + "description": "The median quoted market value of a constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "top_10_market_value", + "type": "float | None", + "description": "The combined quoted market value of the ten largest constituents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "largest_constituent_market_value", + "type": "float | None", + "description": "The quoted market value of the largest constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "smallest_constituent_market_value", + "type": "float | None", + "description": "The quoted market value of the smallest constituent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "largest_constituent_weight", + "type": "float | None", + "description": "The weight of the largest constituent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "smallest_constituent_weight", + "type": "float | None", + "description": "The weight of the smallest constituent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "previous_day", + "type": "float | None", + "description": "The price return over the previous session.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "month_to_date", + "type": "float | None", + "description": "The month-to-date price return.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "quarter_to_date", + "type": "float | None", + "description": "The quarter-to-date price return.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_to_date", + "type": "float | None", + "description": "The year-to-date price return.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "pe_ratio", + "type": "float | None", + "description": "The price-to-earnings ratio of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pb_ratio", + "type": "float | None", + "description": "The price-to-book ratio of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_sales", + "type": "float | None", + "description": "The price-to-sales ratio of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_cash_flow", + "type": "float | None", + "description": "The price-to-cash-flow ratio of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "The dividend yield of the index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "TmxIndexInfo", + "openapi_extra": { + "model": "TmxIndexInfo" + } + }, + "/tmx/index/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Daily open, high, low, close, and volume for an index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Daily levels of an index.\nobb.tmx.index.historical(symbol='^TSX', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. The daily levels are cached for six hours. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIndexHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "change", + "type": "float | None", + "description": "The change in the level from the previous session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change in the level from the previous session, as a percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "vwap", + "type": "float | None", + "description": "The volume weighted average price of the session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_value", + "type": "float | None", + "description": "The total value traded over the session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transactions", + "type": "int | None", + "description": "The number of transactions over the session.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxIndexHistorical", + "openapi_extra": { + "widget_config": { + "name": "TMX Index Historical Levels", + "description": "Daily levels of an S&P/TSX index.", + "category": "Markets", + "subCategory": "Index", + "type": "advanced_charting", + "endpoint": "api/v1/tmx/udf", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "defaultSymbol": "^TSX", + "updateFrequency": 60000 + }, + "source": [ + "TMX" + ] + }, + "model": "TmxIndexHistorical" + } + }, + "/tmx/index/constituents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Constituents of an index, with weights and key data.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Index constituents and weights.\nobb.tmx.index.constituents(symbol='^TSX', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIndexConstituents", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the constituent company in the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the constituent is listed on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_value", + "type": "float | None", + "description": "The quoted market value of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "The weight of the constituent in the index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "TmxIndexConstituents", + "openapi_extra": { + "model": "TmxIndexConstituents" + } + }, + "/tmx/index/sectors": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Sector weights of an index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Index sector weights.\nobb.tmx.index.sectors(symbol='^TSX', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. All Index data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 1 day.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIndexSectors", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "sector", + "type": "str", + "description": "The sector name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float", + "description": "The weight of the sector in the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "tmx": [] + }, + "model": "TmxIndexSectors", + "openapi_extra": { + "model": "TmxIndexSectors" + } + }, + "/tmx/index/snapshots": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Levels and performance for an entire index region.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Index levels and performance.\nobb.tmx.index.snapshots(region='ca', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "region", + "type": "str | None", + "description": "The region of focus for the data - i.e., us, eu.", + "default": "us", + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "x-widget_config": { + "options": [ + { + "label": "Canada", + "value": "ca" + }, + { + "label": "United States", + "value": "us" + } + ] + } + } + } + } + ], + "tmx": [ + { + "name": "region", + "type": "str | None", + "description": "The region the indices are published for.", + "default": "ca", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIndexSnapshots", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Current price of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in value of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change, in normalized percentage points, of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "year_high", + "type": "float | None", + "description": "The 52-week high of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The 52-week low of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_mtd", + "type": "float | None", + "description": "The month-to-date return of the index, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_qtd", + "type": "float | None", + "description": "The quarter-to-date return of the index, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_ytd", + "type": "float | None", + "description": "The year-to-date return of the index, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "total_market_value", + "type": "float | None", + "description": "The total quoted market value of the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_constituents", + "type": "int | None", + "description": "The number of constituents in the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "constituent_average_market_value", + "type": "float | None", + "description": "The average quoted market value of the index constituents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "constituent_median_market_value", + "type": "float | None", + "description": "The median quoted market value of the index constituents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "constituent_top10_market_value", + "type": "float | None", + "description": "The sum of the top 10 quoted market values of the index constituents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "constituent_largest_market_value", + "type": "float | None", + "description": "The largest quoted market value of the index constituents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "constituent_largest_weight", + "type": "float | None", + "description": "The largest weight of the index constituents, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "constituent_smallest_market_value", + "type": "float | None", + "description": "The smallest quoted market value of the index constituents.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "constituent_smallest_weight", + "type": "float | None", + "description": "The smallest weight of the index constituents, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "TmxIndexSnapshots", + "openapi_extra": { + "widget_config": { + "name": "TMX Index Snapshots", + "description": "Levels, performance, and key data for a region's indices.", + "source": [ + "TMX" + ], + "params": [ + { + "paramName": "region", + "value": "ca", + "options": [ + { + "label": "Canada", + "value": "ca" + }, + { + "label": "United States", + "value": "us" + } + ] + } + ] + }, + "model": "TmxIndexSnapshots" + } + }, + "/tmx/index/documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Factsheet and methodology documents published for an index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Factsheets and methodologies published for an index.\nobb.tmx.index.documents(symbol='^TSX', provider='tmx')\n# Every document TMX publishes.\nobb.tmx.index.documents(provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str | None", + "description": "The index symbol. Every published document when not supplied.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "document_type", + "type": "str | None", + "description": "The kind of document to list.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxIndexDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "The index the document describes.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "index_name", + "type": "str | None", + "description": "The name of the index the document describes.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "The title of the document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "document_type", + "type": "str", + "description": "The kind of document, factsheet or methodology.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "The URL of the PDF.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "TmxIndexDocuments", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "TmxIndexDocuments" + } + }, + "/tmx/index/document_view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve every selected document to the viewer.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "params", + "type": "DocumentRequest", + "description": "", + "default": null, + "optional": false + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Index Documents", + "description": "Factsheets and methodologies published for the S&P/TSX index family.", + "type": "multi_file_viewer", + "category": "Index", + "subCategory": "Documents", + "widgetId": "tmx_index_documents_obb", + "params": [ + { + "paramName": "symbol", + "label": "Index", + "description": "The index to read documents for.", + "type": "endpoint", + "value": "^TSX", + "optionsEndpoint": "/api/v1/tmx/index/symbol_choices" + }, + { + "paramName": "document_type", + "label": "Document", + "description": "The kind of document to offer.", + "type": "text", + "value": "all", + "options": [ + { + "label": "All", + "value": "all" + }, + { + "label": "Factsheet", + "value": "factsheet" + }, + { + "label": "Methodology", + "value": "methodology" + } + ] + }, + { + "paramName": "url", + "type": "endpoint", + "optionsEndpoint": "/api/v1/tmx/index/document_choices", + "optionsParams": { + "symbol": "$symbol", + "document_type": "$document_type" + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + } + ], + "gridData": { + "w": 20, + "h": 28 + }, + "refetchInterval": false, + "source": [ + "TMX" + ] + } + } + }, + "/tmx/derivatives/options/straddle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long straddle at each expiration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Long straddle cost at each expiration.\nobb.tmx.derivatives.options.straddle(symbol='AC')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Straddle", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike_1", + "headerName": "Strike 1", + "cellDataType": "number" + }, + { + "field": "strike_2", + "headerName": "Strike 2", + "cellDataType": "number" + }, + { + "field": "strike_1_premium", + "headerName": "Strike 1 Premium", + "cellDataType": "number" + }, + { + "field": "strike_2_premium", + "headerName": "Strike 2 Premium", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_lower_percent", + "headerName": "Breakeven Lower %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + }, + { + "field": "breakeven_upper_percent", + "headerName": "Breakeven Upper %", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "" + } + }, + "/tmx/derivatives/options/strangle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long strangle at each expiration for a given moneyness.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Long strangle cost at each expiration.\nobb.tmx.derivatives.options.strangle(symbol='AC')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent out-of-the-money for both legs.", + "default": 5, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Strangle", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike_1", + "headerName": "Strike 1", + "cellDataType": "number" + }, + { + "field": "strike_2", + "headerName": "Strike 2", + "cellDataType": "number" + }, + { + "field": "strike_1_premium", + "headerName": "Strike 1 Premium", + "cellDataType": "number" + }, + { + "field": "strike_2_premium", + "headerName": "Strike 2 Premium", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_lower_percent", + "headerName": "Breakeven Lower %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + }, + { + "field": "breakeven_upper_percent", + "headerName": "Breakeven Upper %", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "" + } + }, + "/tmx/derivatives/options/spreads": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price the vertical spreads at each expiration.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Vertical spreads at each expiration.\nobb.tmx.derivatives.options.spreads(symbol='AC', spread_type='call')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "spread_type", + "type": "str", + "description": "Vertical call spreads, put spreads, or both.", + "default": "both", + "optional": true + }, + { + "name": "near_moneyness", + "type": "float", + "description": "Percent out-of-the-money for the near leg.", + "default": 2.5, + "optional": true + }, + { + "name": "far_moneyness", + "type": "float", + "description": "Percent out-of-the-money for the far leg.", + "default": 7.5, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Spreads", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 12 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "strategy", + "headerName": "Strategy", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "expiration", + "headerName": "Expiration", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "sold_strike", + "headerName": "Sold Strike", + "cellDataType": "number" + }, + { + "field": "bought_strike", + "headerName": "Bought Strike", + "cellDataType": "number" + }, + { + "field": "sold_premium", + "headerName": "Sold Premium", + "cellDataType": "number" + }, + { + "field": "bought_premium", + "headerName": "Bought Premium", + "cellDataType": "number" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + }, + { + "field": "cost", + "headerName": "Cost", + "cellDataType": "number" + }, + { + "field": "cost_percent", + "headerName": "Cost %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "max_profit", + "headerName": "Max Profit", + "cellDataType": "number" + }, + { + "field": "max_loss", + "headerName": "Max Loss", + "cellDataType": "number" + }, + { + "field": "breakeven_lower", + "headerName": "Breakeven Lower", + "cellDataType": "number" + }, + { + "field": "breakeven_lower_percent", + "headerName": "Breakeven Lower %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "breakeven_upper", + "headerName": "Breakeven Upper", + "cellDataType": "number" + }, + { + "field": "breakeven_upper_percent", + "headerName": "Breakeven Upper %", + "cellDataType": "number", + "formatterFn": "percent" + } + ] + } + } + }, + "model": "" + } + }, + "/tmx/derivatives/options/chains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Complete option chain across every expiry, with greeks.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The full options chain for a symbol.\nobb.tmx.derivatives.options.chains(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "date", + "type": "date | None | str", + "description": "A specific date to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxOptionsChains", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "underlying_symbol", + "type": "list[str] | None", + "description": "Underlying symbol for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_price", + "type": "list[float] | None", + "description": "Price of the underlying stock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "contract_symbol", + "type": "list[str]", + "description": "Contract symbol for the option.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eod_date", + "type": "list[date] | None", + "description": "Date for which the options chains are returned.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "list[date]", + "description": "Expiration date of the contract.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "dte", + "type": "list[int] | None", + "description": "Days to expiration of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strike", + "type": "list[float]", + "description": "Strike price of the contract.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "option_type", + "type": "list[str]", + "description": "Call or Put.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "contract_size", + "type": "list[Union[int, float]] | None", + "description": "Number of underlying units per contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "list[Union[int, float]] | None", + "description": "Open interest on the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "list[Union[int, float]] | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "theoretical_price", + "type": "list[float] | None", + "description": "Theoretical value of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_price", + "type": "list[float] | None", + "description": "Last trade price of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_trade_size", + "type": "list[Union[int, float]] | None", + "description": "Last trade size of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_trade_time", + "type": "list[datetime] | None", + "description": "The timestamp of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tick", + "type": "list[str] | None", + "description": "Whether the last tick was up or down in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "list[float] | None", + "description": "Current bid price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_size", + "type": "list[Union[int, float]] | None", + "description": "Bid size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_time", + "type": "list[datetime] | None", + "description": "The timestamp of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "list[str] | None", + "description": "The exchange of the bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "list[float] | None", + "description": "Current ask price for the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_size", + "type": "list[Union[int, float]] | None", + "description": "Ask size for the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_time", + "type": "list[datetime] | None", + "description": "The timestamp of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "list[str] | None", + "description": "The exchange of the ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mark", + "type": "list[float] | None", + "description": "The mid-price between the latest bid and ask.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open", + "type": "list[float] | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_bid", + "type": "list[float] | None", + "description": "The opening bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "open_ask", + "type": "list[float] | None", + "description": "The opening ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "high", + "type": "list[float] | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_high", + "type": "list[float] | None", + "description": "The highest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_high", + "type": "list[float] | None", + "description": "The highest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "low", + "type": "list[float] | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "bid_low", + "type": "list[float] | None", + "description": "The lowest bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ask_low", + "type": "list[float] | None", + "description": "The lowest ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close", + "type": "list[float] | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_size", + "type": "list[Union[int, float]] | None", + "description": "The closing trade size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_time", + "type": "list[datetime] | None", + "description": "The time of the closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid", + "type": "list[float] | None", + "description": "The closing bid price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "close_bid_size", + "type": "list[Union[int, float]] | None", + "description": "The closing bid size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_bid_time", + "type": "list[datetime] | None", + "description": "The time of the bid closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask", + "type": "list[float] | None", + "description": "The closing ask price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_size", + "type": "list[Union[int, float]] | None", + "description": "The closing ask size for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close_ask_time", + "type": "list[datetime] | None", + "description": "The time of the ask closing price for the option that day.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "list[float] | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "list[float] | None", + "description": "The change in the price of the option.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "list[float] | None", + "description": "Change, in normalized percentage points, of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "implied_volatility", + "type": "list[float] | None", + "description": "Implied volatility of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "delta", + "type": "list[float] | None", + "description": "Delta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "gamma", + "type": "list[float] | None", + "description": "Gamma of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "theta", + "type": "list[float] | None", + "description": "Theta of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "vega", + "type": "list[float] | None", + "description": "Vega of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + }, + { + "name": "rho", + "type": "list[float] | None", + "description": "Rho of the option.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "decimal" + } + } + ], + "tmx": [ + { + "name": "transactions", + "type": "list[int] | None", + "description": "Number of transactions for the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_value", + "type": "list[float] | None", + "description": "Total value of the transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_price", + "type": "list[float] | None", + "description": "Settlement price on that date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxOptionsChains", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Chains", + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 16 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "expiration", + "headerName": "Expiration", + "pinned": "left", + "cellDataType": "text" + }, + { + "field": "dte", + "headerName": "DTE", + "cellDataType": "number" + }, + { + "field": "strike", + "headerName": "Strike", + "cellDataType": "number" + }, + { + "field": "option_type", + "headerName": "Type", + "cellDataType": "text" + }, + { + "field": "contract_symbol", + "headerName": "Contract", + "cellDataType": "text" + }, + { + "field": "open_interest", + "headerName": "OI", + "cellDataType": "number" + }, + { + "field": "volume", + "headerName": "Volume", + "cellDataType": "number" + }, + { + "field": "last_trade_price", + "headerName": "Last", + "cellDataType": "number" + }, + { + "field": "bid", + "headerName": "Bid", + "cellDataType": "number" + }, + { + "field": "ask", + "headerName": "Ask", + "cellDataType": "number" + }, + { + "field": "change", + "headerName": "Change", + "cellDataType": "number" + }, + { + "field": "change_percent", + "headerName": "Change %", + "cellDataType": "number", + "formatterFn": "percent" + }, + { + "field": "implied_volatility", + "headerName": "IV", + "cellDataType": "number" + }, + { + "field": "delta", + "headerName": "Delta", + "cellDataType": "number" + }, + { + "field": "gamma", + "headerName": "Gamma", + "cellDataType": "number" + }, + { + "field": "theta", + "headerName": "Theta", + "cellDataType": "number" + }, + { + "field": "vega", + "headerName": "Vega", + "cellDataType": "number" + }, + { + "field": "rho", + "headerName": "Rho", + "cellDataType": "number" + }, + { + "field": "underlying_symbol", + "headerName": "Underlying", + "cellDataType": "text" + }, + { + "field": "underlying_price", + "headerName": "Underlying Price", + "cellDataType": "number" + } + ] + } + } + }, + "model": "TmxOptionsChains" + } + }, + "/tmx/derivatives/options/covered_calls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen listed calls by annualized premium return and potential capital gain.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Screen listed calls for covered-write returns.\nobb.tmx.derivatives.options.covered_calls(provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str | None", + "description": "Restrict to one underlying. Leave unset to screen every listing.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str | None", + "description": "Restrict to one expiry month, as YYYY-MM.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "premium_return_min", + "type": "float | None", + "description": "Minimum annualized premium return, in percent. The exchange enforces a floor of 0.5.", + "default": 5.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "capital_gain_min", + "type": "float | None", + "description": "Minimum annualized potential capital gain, in percent. The exchange enforces a floor of 0.5.", + "default": 5.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CoveredCallScreener", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "date | None", + "description": "Expiration date of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strike", + "type": "float | None", + "description": "Strike price of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_price", + "type": "float | None", + "description": "Last price of the underlying.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_return", + "type": "float | None", + "description": "Annualized potential total return, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "premium_return", + "type": "float | None", + "description": "Annualized premium return, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "capital_gain", + "type": "float | None", + "description": "Annualized potential capital gain, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "bid", + "type": "float | None", + "description": "Bid price of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_size", + "type": "int | None", + "description": "Bid size.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "Ask price of the contract.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_size", + "type": "int | None", + "description": "Ask size.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "Contract volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open_interest", + "type": "int | None", + "description": "Open interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CoveredCallScreener", + "openapi_extra": { + "model": "CoveredCallScreener" + } + }, + "/tmx/derivatives/options/get_tickers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve expiry/strike dropdown choices for a symbol, loading it on first call.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "", + "optional": true + }, + { + "name": "expiry_list", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "strike_list", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/tmx/derivatives/options/smile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility smile / skew across strikes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "expirations", + "type": "str", + "description": "Up to five expiration dates (comma-separated).", + "default": null, + "optional": true + }, + { + "name": "otm", + "type": "bool", + "description": "Show only out-of-the-money contracts.", + "default": false, + "optional": true + }, + { + "name": "skew", + "type": "bool", + "description": "Plot skew relative to ATM instead of IV.", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Smile", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/tmx/derivatives/options/surface": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Plot the chain as a surface over days to expiry and strike.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "The surface to plot.", + "default": "implied_volatility", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "The contracts to plot.", + "default": "otm", + "optional": true + }, + { + "name": "dte_min", + "type": "int", + "description": "Minimum days until expiration.", + "default": null, + "optional": true + }, + { + "name": "dte_max", + "type": "int", + "description": "Maximum days until expiration.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent from the underlying price to include.", + "default": null, + "optional": true + }, + { + "name": "strike_min", + "type": "float", + "description": "Lowest strike to include.", + "default": null, + "optional": true + }, + { + "name": "strike_max", + "type": "float", + "description": "Highest strike to include.", + "default": null, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Surface", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/tmx/derivatives/options/stats": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open-interest or volume statistics by strike or expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "by", + "type": "str", + "description": "Aggregate by strike or expiration.", + "default": "expiration", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Open interest or volume.", + "default": "oi", + "optional": true + }, + { + "name": "date", + "type": "str", + "description": "Expiry to view by strike (switches 'by' to strike).", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "Raw values, share of total, or put/call ratio.", + "default": "value", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Stats", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/tmx/derivatives/options/term_structure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied volatility or price across expirations.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying symbol. Suffix with ':US' for OPRA-listed contracts; a bare symbol resolves to the Montreal Exchange listing.", + "default": "AC", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM per expiry.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "Percent out-of-the-money instead of a fixed strike.", + "default": null, + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Implied volatility or price.", + "default": "iv", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "Which side of the chain to plot.", + "default": "both", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Options Term Structure", + "type": "chart", + "raw": true, + "category": "Derivatives", + "subCategory": "Options", + "source": [ + "TMX" + ], + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/tmx/derivatives/futures/instruments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Every instrument listed on the Montreal Exchange.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The Montreal Exchange universe.\nobb.tmx.derivatives.futures.instruments(provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "asset_class", + "type": "str | None", + "description": "Restrict to one Montreal Exchange instrument class.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "instrument_type", + "type": "str | None", + "description": "Restrict to 'future' or 'option'. Defaults to futures only; set to None for the complete listed universe.", + "default": "future", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxFuturesInstruments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "The Montreal Exchange root symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the underlying or product, where TMX publishes one.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "instrument_type", + "type": "str | None", + "description": "Whether the product is an option or a future.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "underlying_symbol", + "type": "str | None", + "description": "The symbol of the underlying instrument.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiry_cycle", + "type": "str | None", + "description": "The listed expiry cycle, either 'standard' or 'short'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "has_weekly_options", + "type": "bool | None", + "description": "Whether weekly expirations are listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "has_long_term_options", + "type": "bool | None", + "description": "Whether long-term equity options are listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The instrument class.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_class_name", + "type": "str | None", + "description": "The instrument class, as published.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_symbol", + "type": "str | None", + "description": "The symbol that quotes the front contract, where one exists.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxFuturesInstruments", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "symbol", + "description": "The contract a click on the instrument list selects.", + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol" + } + } + } + ] + } + } + }, + "model": "TmxFuturesInstruments" + } + }, + "/tmx/derivatives/futures/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical prices for a futures contract.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Futures price history.\nobb.tmx.derivatives.futures.historical(symbol='CGB', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str | None", + "description": "Future expiry date with format YYYY-MM", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "interval", + "type": "str | None", + "description": "The interval of the bars.", + "default": "day", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Day", + "value": "day" + }, + { + "label": "Week", + "value": "week" + }, + { + "label": "Month", + "value": "month" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxFuturesHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [] + }, + "model": "TmxFuturesHistorical", + "openapi_extra": { + "widget_config": { + "name": "TMX Futures Historical Price", + "description": "Futures prices, charted over the TMX quote feed.", + "category": "Markets", + "type": "advanced_charting", + "endpoint": "api/v1/tmx/udf", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "defaultSymbol": "CGB", + "updateFrequency": 60000 + } + }, + "model": "TmxFuturesHistorical" + } + }, + "/tmx/currency/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Historical rates for a currency pair.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Currency pair history.\nobb.tmx.currency.historical(symbol='USDCAD', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "interval", + "type": "str | None", + "description": "The interval of the bars.", + "default": "day", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Day", + "value": "day" + }, + { + "label": "Week", + "value": "week" + }, + { + "label": "Month", + "value": "month" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxCurrencyHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [] + }, + "model": "TmxCurrencyHistorical", + "openapi_extra": { + "widget_config": { + "name": "TMX Currency Historical Price", + "description": "Currency rates, charted over the TMX quote feed.", + "category": "Markets", + "type": "advanced_charting", + "endpoint": "api/v1/tmx/udf", + "gridData": { + "w": 40, + "h": 20 + }, + "data": { + "defaultSymbol": "USDCAD", + "updateFrequency": 60000 + } + }, + "model": "TmxCurrencyHistorical" + } + }, + "/tmx/fixedincome/prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return reference data and last prices for every CIRO-designated bond.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The designated bond master.\nobb.tmx.fixedincome.prices(provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data. Matches partial name.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issuer_name", + "type": "str | None", + "description": "Name of the issuer. Returns partial matches and is case insensitive.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "list | str | None | list[list | str | None]", + "description": "International Securities Identification Number(s) of the bond(s). Multiple items allowed for provider(s): tmx.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "multiple_items_allowed": true + } + } + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier of the issuing entity.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "list | str | None", + "description": "Currency of the bond. Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "coupon_min", + "type": "float | None", + "description": "Minimum coupon rate of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "coupon_max", + "type": "float | None", + "description": "Maximum coupon rate of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issued_amount_min", + "type": "int | None", + "description": "Minimum issued amount of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issued_amount_max", + "type": "str | None", + "description": "Maximum issued amount of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date_min", + "type": "date | None", + "description": "Minimum maturity date of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date_max", + "type": "date | None", + "description": "Maximum maturity date of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "issue_date_min", + "type": "date | None", + "description": "Filter by the minimum original issue date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issue_date_max", + "type": "date | None", + "description": "Filter by the maximum original issue date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "last_traded_min", + "type": "date | None", + "description": "Filter by the minimum last trade date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxBondPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier of the issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "figi", + "type": "str | None", + "description": "FIGI of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "coupon_rate", + "type": "float | None", + "description": "Coupon rate of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "tmx": [ + { + "name": "ytm", + "type": "float | None", + "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate. Values are returned as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "price", + "type": "float | None", + "description": "The last price for the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "highest_price", + "type": "float | None", + "description": "The highest price for the bond on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "lowest_price", + "type": "float | None", + "description": "The lowest price for the bond on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "total_trades", + "type": "int | None", + "description": "Total number of trades on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_traded_date", + "type": "date | None", + "description": "Last traded date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Maturity date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date | None", + "description": "Issue date of the bond. This is the date when the bond first accrues interest.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer_name", + "type": "str | None", + "description": "Name of the issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxBondPrices", + "openapi_extra": { + "widget_config": { + "params": [ + { + "paramName": "cusip", + "description": "The bond a click on the list selects.", + "show": false + } + ], + "data": { + "table": { + "columnsDefs": [ + { + "field": "cusip", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "cusip" + } + } + } + ] + } + } + }, + "model": "TmxBondPrices" + } + }, + "/tmx/fixedincome/trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Every reported trade for a bond, across its full history.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Reported bond trades.\nobb.tmx.fixedincome.trades(cusip='135087U28', provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "country", + "type": "str | None", + "description": "The country to get data. Matches partial name.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "ISIN of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issuer_type", + "type": "str | None", + "description": "Type of bond issuer.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "tmx": { + "x-widget_config": { + "options": [ + { + "label": "Government", + "value": "government" + }, + { + "label": "Corporate", + "value": "corporate" + }, + { + "label": "Municipal", + "value": "municipal" + } + ] + } + } + } + }, + { + "name": "notional_currency", + "type": "str | None", + "description": "Currency of the bond, which might differ from the currency of the trade.\n Formatted as the 3-letter ISO 4217 code (e.g. GBP, EUR, USD).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | str | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. YYYY-MM-DD or ISO-8601 format. E.g. 2023-01-14T10:55:00Z", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | str | None | str", + "description": "End date of the data, in YYYY-MM-DD format. YYYY-MM-DD or ISO-8601 format. E.g. 2023-01-14T10:55:00Z", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the bond. One of cusip, isin, or figi is required.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "figi", + "type": "str | None", + "description": "FIGI of the bond.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "account_type", + "type": "str | None", + "description": "Restrict to trades booked to one account type.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All", + "value": "all" + }, + { + "label": "Retail", + "value": "retail" + }, + { + "label": "Institutional", + "value": "institutional" + } + ] + } + } + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk bond master. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxBondTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "trade_date", + "type": "date | datetime | None", + "description": "Date of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "ISIN of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "figi", + "type": "str | None", + "description": "FIGI of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "Price of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "current_yield", + "type": "float | None", + "description": "Current yield of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "coupon_rate", + "type": "float | None", + "description": "Coupon rate of the bond.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "trade_date", + "type": "datetime | None", + "description": "Execution date and time of the trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "settlement_date", + "type": "date | None", + "description": "Settlement date of the trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "The issuer of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Maturity date of the bond.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type", + "type": "str | None", + "description": "The type of transaction reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "account_type", + "type": "str | None", + "description": "The account type the trade was booked to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commission", + "type": "bool | None", + "description": "Whether a commission was charged.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_capped", + "type": "bool | None", + "description": "Whether the reported volume is capped at the disclosure limit.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reported_date", + "type": "date | None", + "description": "The date the trade was submitted to CIRO, which is later than the execution date when a trade is reported late or amended.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "record_id", + "type": "str | None", + "description": "CIRO's unique identifier for the trade record.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TmxBondTrades", + "openapi_extra": { + "model": "TmxBondTrades" + } + }, + "/tmx/fixedincome/treasury_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government of Canada bond reference data and prices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Government of Canada bond prices.\nobb.tmx.fixedincome.treasury_prices(provider='tmx')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "A specific date to get data for. Defaults to the last business day.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "govt_type", + "type": "str | None", + "description": "The level of government issuer.", + "default": "federal", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Federal", + "value": "federal" + }, + { + "label": "Provincial", + "value": "provincial" + }, + { + "label": "Municipal", + "value": "municipal" + } + ] + } + } + }, + { + "name": "issue_date_min", + "type": "date | None", + "description": "Filter by the minimum original issue date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "issue_date_max", + "type": "date | None", + "description": "Filter by the maximum original issue date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "last_traded_min", + "type": "date | None", + "description": "Filter by the minimum last trade date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date_min", + "type": "date | None", + "description": "Filter by the minimum maturity date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date_max", + "type": "date | None", + "description": "Filter by the maximum maturity date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "All bond data is sourced from a single JSON file that is updated daily. The file is cached for one day to eliminate downloading more than once. Caching will significantly speed up subsequent queries. To bypass, set to False.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TmxTreasuryPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "issuer_name", + "type": "str | None", + "description": "Name of the issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "ISIN of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date | None", + "description": "The original issue date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "The maturity date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_date", + "type": "date | None", + "description": "The call date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "The bid price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "offer", + "type": "float | None", + "description": "The offer price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "eod_price", + "type": "float | None", + "description": "The end-of-day price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_traded_date", + "type": "date | None", + "description": "The last trade date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_trades", + "type": "int | None", + "description": "Total number of trades on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "highest_price", + "type": "float | None", + "description": "The highest price for the bond on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "lowest_price", + "type": "float | None", + "description": "The lowest price for the bond on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "rate", + "type": "float | None", + "description": "The annualized interest rate or coupon of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ytm", + "type": "float | None", + "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "tmx": [] + }, + "model": "TmxTreasuryPrices", + "openapi_extra": { + "model": "TmxTreasuryPrices" + } + }, + "/tmx/markets/movers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Rank the biggest movers on an exchange.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Gainers and losers by exchange.\nobb.tmx.markets.movers(exchange='tsx', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "nasdaq": [ + { + "name": "category", + "type": "str | None", + "description": "The mover list to return.", + "default": "most_active_share_volume", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "asset_class", + "type": "str | None", + "description": "The asset class. Mutual funds publish advancers and decliners only; ETFs add most-active by share volume.", + "default": "stocks", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "session", + "type": "str | None", + "description": "The trading session the list is ranked over.", + "default": "market", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of movers to return.", + "default": 10, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "exchange", + "type": "str | None", + "description": "The exchange to rank.", + "default": "tsx", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Toronto Stock Exchange", + "value": "tsx" + }, + { + "label": "TSX Venture Exchange", + "value": "tsxv" + } + ] + } + } + }, + { + "name": "category", + "type": "str | None", + "description": "The direction to rank by.", + "default": "gainers", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Gainers", + "value": "gainers" + }, + { + "label": "Losers", + "value": "losers" + } + ] + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of movers to return.", + "default": 25, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "MarketMovers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name associated with the ticker.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "The last price of the ticker.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float", + "description": "The change in price from open.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float", + "description": "The change in percent from open.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "nasdaq": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "price", + "type": "float | None", + "description": "The last price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change in price from open.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change in percent from open.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | None", + "description": "The share or dollar volume, for the most-active lists.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "tmx": [ + { + "name": "price", + "type": "float | None", + "description": "The last price of the ticker.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "The change in price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "The change in percent.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The session open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The session high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The session low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The session share volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trade_volume", + "type": "int | None", + "description": "The number of trades in the session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "week_52_high", + "type": "float | None", + "description": "The fifty-two week high.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "week_52_low", + "type": "float | None", + "description": "The fifty-two week low.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the ticker trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "MarketMovers", + "openapi_extra": { + "model": "MarketMovers" + } + }, + "/tmx/markets/trades": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Recent trades, with the buying and selling brokers.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Time and sales with broker attribution.\nobb.tmx.markets.trades(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of trades to return, most recent first.", + "default": 50, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EquityTrades", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "date", + "type": "datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price the trade printed at.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The number of shares traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The marketplace the trade printed on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "buyer_id", + "type": "str | None", + "description": "The broker number on the buy side.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "buyer_name", + "type": "str | None", + "description": "The broker on the buy side.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seller_id", + "type": "str | None", + "description": "The broker number on the sell side.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "seller_name", + "type": "str | None", + "description": "The broker on the sell side.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "EquityTrades", + "openapi_extra": { + "model": "EquityTrades" + } + }, + "/tmx/markets/short_interest": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Short interest and days to cover.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Reported short interest.\nobb.tmx.markets.short_interest(symbol='AC', provider='tmx')\n```\n\n", + "parameters": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "use_cache", + "type": "bool | None", + "description": "Whether to use the on-disk response cache. Set to False to bypass.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ShortInterest", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "tmx": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "settlement_date", + "type": "date | None", + "description": "The settlement date of the reported position.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_interest", + "type": "int | None", + "description": "Number of shares held short.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_interest_percent", + "type": "float | None", + "description": "Short interest as a percent of the outstanding float.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "days_to_cover_10d", + "type": "float | None", + "description": "Days to cover, against the ten-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_to_cover_30d", + "type": "float | None", + "description": "Days to cover, against the thirty-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_to_cover_90d", + "type": "float | None", + "description": "Days to cover, against the ninety-day average volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ShortInterest", + "openapi_extra": { + "model": "ShortInterest" + } + }, + "/tmx/news/feed": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Company news in the shape the news feed widget renders.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The latest articles, with their bodies.\nobb.tmx.news.feed(symbol='AC')\n# The second page of headlines.\nobb.tmx.news.feed(symbol='AC', limit=20, offset=20)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The symbol to read.", + "default": "AC", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "The number of articles to return.", + "default": 20, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "The number of articles to skip.", + "default": 0, + "optional": true + }, + { + "name": "fetch_body", + "type": "bool", + "description": "Read each article for its full body.", + "default": true, + "optional": true + }, + { + "name": "locale", + "type": "str", + "description": "The language to read, 'en' or 'fr'.", + "default": "en", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX News Feed", + "description": "Company news from the TMX feed, with the full article body.", + "type": "newsfeed", + "category": "News", + "subCategory": "TMX", + "source": [ + "TMX" + ], + "gridData": { + "w": 20, + "h": 15 + }, + "refetchInterval": 300000, + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AC", + "description": "The symbol to read the news of." + }, + { + "paramName": "limit", + "label": "Limit", + "value": 20, + "description": "The number of articles to return.", + "type": "number", + "optional": true + }, + { + "paramName": "offset", + "label": "Offset", + "value": 0, + "description": "The number of articles to skip.", + "type": "number", + "optional": true + }, + { + "paramName": "fetch_body", + "label": "Fetch full body", + "value": true, + "description": "Read each article for its full body.", + "type": "boolean", + "optional": true + } + ] + }, + "model": "" + } + }, + "/tmx/news/market": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "News across a basket of symbols, in the news feed widget's shape.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# News across the large banks.\nobb.tmx.news.market(symbols='RY,TD,BMO,BNS,CM')\n# Only the earnings coverage.\nobb.tmx.news.market(symbols='RY,TD', topic='FINANCIAL RESULTS')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbols", + "type": "str", + "description": "The symbols the news should cover.", + "default": "AC,RY,BCE,ENB,SHOP", + "optional": true + }, + { + "name": "topic", + "type": "str", + "description": "Keep only the articles carrying this subject.", + "default": null, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Articles to return.", + "default": 20, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Articles to skip.", + "default": 0, + "optional": true + }, + { + "name": "fetch_body", + "type": "bool", + "description": "Read each article for its full body.", + "default": true, + "optional": true + }, + { + "name": "locale", + "type": "str", + "description": "The language to read.", + "default": "en", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Market News", + "description": "News across a basket of symbols, with the full article body and its subject tagging.", + "type": "newsfeed", + "category": "News", + "subCategory": "TMX", + "source": [ + "TMX" + ], + "gridData": { + "w": 20, + "h": 15 + }, + "refetchInterval": 300000, + "params": [ + { + "paramName": "symbols", + "label": "Symbols", + "value": "AC,RY,BCE,ENB,SHOP", + "description": "The symbols the news should cover." + }, + { + "paramName": "topic", + "label": "Topic", + "value": null, + "description": "Keep only the articles carrying this subject.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/tmx/news/topics", + "optionsParams": { + "symbols": "$symbols" + }, + "optional": true + }, + { + "paramName": "limit", + "label": "Limit", + "value": 20, + "type": "number", + "optional": true + }, + { + "paramName": "offset", + "label": "Offset", + "value": 0, + "type": "number", + "optional": true + }, + { + "paramName": "fetch_body", + "label": "Fetch full body", + "value": true, + "type": "boolean", + "optional": true + } + ] + }, + "model": "" + } + }, + "/tmx/news/blog": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Read the TMX Money editorial feed, in the news feed widget's shape.\n\n Returns\n -------\n list\n\n Examples\n --------\n >>> from openbb import obb\n >>> # The latest posts.\n >>> obb.tmx.news.blog()", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# The latest posts.\nobb.tmx.news.blog()\n```\n\n", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX Money Blog", + "description": "The TMX Money editorial feed, with the full post body.", + "type": "newsfeed", + "category": "News", + "subCategory": "TMX", + "source": [ + "TMX" + ], + "gridData": { + "w": 20, + "h": 15 + }, + "refetchInterval": 900000 + }, + "model": "" + } + }, + "/tmx/news/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search the published corpus, in the news feed widget's shape.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the news.\nobb.tmx.news.search(query='drilling')\n# The second page of results.\nobb.tmx.news.search(query='lithium', limit=20, offset=20)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "query", + "type": "str", + "description": "The words to search for.", + "default": "", + "optional": true + }, + { + "name": "content_type", + "type": "str", + "description": "The kind of content to search.", + "default": "News", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "Results to return.", + "default": 20, + "optional": true + }, + { + "name": "offset", + "type": "int", + "description": "Results to skip.", + "default": 0, + "optional": true + }, + { + "name": "fetch_body", + "type": "bool", + "description": "Read each article for its full body.", + "default": true, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TMX News Search", + "description": "Search the published corpus by query string, with the full article body.", + "type": "newsfeed", + "category": "News", + "subCategory": "TMX", + "source": [ + "TMX" + ], + "gridData": { + "w": 20, + "h": 15 + }, + "refetchInterval": false, + "params": [ + { + "paramName": "query", + "label": "Query", + "value": "drilling", + "description": "The words to search for." + }, + { + "paramName": "content_type", + "label": "Content", + "value": "News", + "description": "The kind of content to search.", + "options": [ + { + "label": "News", + "value": "News" + }, + { + "label": "Company", + "value": "Company" + }, + { + "label": "Disclosure", + "value": "CompanyDisclouser" + } + ], + "optional": true + }, + { + "paramName": "limit", + "label": "Limit", + "value": 20, + "type": "number", + "optional": true + }, + { + "paramName": "offset", + "label": "Offset", + "value": 0, + "type": "number", + "optional": true + }, + { + "paramName": "fetch_body", + "label": "Fetch full body", + "value": true, + "type": "boolean", + "optional": true + } + ] + }, + "model": "" + } + }, + "/uscongress/bills": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get and filter lists of Congressional Bills.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.bills(provider='congress_gov')\nobb.uscongress.bills(start_date='2025-01-01', end_date='2025-01-31', provider='congress_gov')\n# Get all bills of type 's' (Senate) for the 118th Congress.\nobb.uscongress.bills(bill_type='s', congress=118, limit=0, provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "congress", + "type": "int | None", + "description": "Congress number (e.g., 118 for the 118th Congress). The 103rd Congress started in 1993, which is the earliest date supporting full text versions. Each Congress spans two years, starting in odd-numbered years.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "bill_type", + "type": "str | None", + "description": "Bill type (e.g., 'hr' for House bills).\n\nMust be one of: hr, s, hjres, sjres, hconres, sconres, hres, sres.\n\nBills\n-----\n\nA bill is the form used for most legislation, whether permanent or temporary, general or special, public or private.\n\nA bill originating in the House of Representatives is designated by the letters \u201cH.R.\u201d,\nsignifying \u201cHouse of Representatives\u201d, followed by a number that it retains throughout all its parliamentary stages.\n\nBills are presented to the President for action when approved in identical form\nby both the House of Representatives and the Senate.\n\nJoint Resolutions\n-----------------\n\nJoint resolutions may originate either in the House of Representatives or in the Senate.\n\nThere is little practical difference between a bill and a joint resolution. Both are subject to the same procedure,\nexcept for a joint resolution proposing an amendment to the Constitution.\n\nOn approval of such a resolution by two-thirds of both the House and Senate,\nit is sent directly to the Administrator of General Services for submission to the individual states for ratification.\n\nIt is not presented to the President for approval.\nA joint resolution originating in the House of Representatives is designated \u201cH.J.Res.\u201d followed by its individual number.\nJoint resolutions become law in the same manner as bills.\n\nConcurrent Resolutions\n----------------------\n\nMatters affecting the operations of both the House of Representatives and Senate\nare usually initiated by means of concurrent resolutions.\n\nA concurrent resolution originating in the House of Representatives is designated \u201cH.Con.Res.\u201d\nfollowed by its individual number.\n\nOn approval by both the House of Representatives and Senate,\nthey are signed by the Clerk of the House and the Secretary of the Senate.\n\nThey are not presented to the President for action.\n\nSimple Resolutions\n------------------\n\nA matter concerning the operation of either the House of Representatives or Senate\nalone is initiated by a simple resolution.\n\nA resolution affecting the House of Representatives is designated \u201cH.Res.\u201d followed by its number.\n\nThey are not presented to the President for action.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "House Bill", + "value": "hr" + }, + { + "label": "Senate Bill", + "value": "s" + }, + { + "label": "House Joint Resolution", + "value": "hjres" + }, + { + "label": "Senate Joint Resolution", + "value": "sjres" + }, + { + "label": "House Concurrent Resolution", + "value": "hconres" + }, + { + "label": "Senate Concurrent Resolution", + "value": "sconres" + }, + { + "label": "House Simple Resolution", + "value": "hres" + }, + { + "label": "Senate Simple Resolution", + "value": "sres" + } + ], + "value": null, + "style": { + "popupWidth": 300 + }, + "paramName": "bill_type", + "label": "Bill Type" + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Filters bills by the last updated date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Filters bills by the last updated date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. When None, default sets to 100 (max 250). Set to 0 for no limit (must be used with 'bill_type' and 'congress'). Setting to 0 will nullify the start_date, end_date, and offset parameters.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The starting record returned. 0 is the first record.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "sort_by", + "type": "str | None", + "description": "Sort by update date. Default is latest first.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressBills", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "bill_id", + "type": "str", + "description": "The bill identifier, e.g. '119-hr-29'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Bill ID", + "headerTooltip": "Click a cell here to group by this bill and view it in the 'Congressional Bill Viewer' / 'Congressional Bill Info' widgets.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "bill_id" + } + } + } + }, + { + "name": "latest_action_date", + "type": "date | None", + "description": "The date of the latest action on the bill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "update_date", + "type": "date", + "description": "The date the bill was last updated.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int", + "description": "The congress session number.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "bill_number", + "type": "int", + "description": "The bill number.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "origin_chamber", + "type": "str", + "description": "The chamber where the bill originated.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "origin_chamber_code", + "type": "str", + "description": "The chamber code where the bill originated.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "bill_type", + "type": "str", + "description": "The type of bill (e.g., HR, S).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The title of the bill.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "latest_action", + "type": "str | None", + "description": "Latest action information for the bill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "update_date_including_text", + "type": "datetime | None", + "description": "The date and time the bill text was last updated.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Text Update Date" + } + } + } + ] + }, + "model": "CongressBills", + "openapi_extra": { + "model": "CongressBills" + } + }, + "/uscongress/laws": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get and filter lists of enacted Congressional Laws (public or private).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.laws(provider='congress_gov')\n# Get the 5 most recent public laws of the 118th Congress.\nobb.uscongress.laws(congress=118, law_type='public', limit=5, provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "congress", + "type": "int | None", + "description": "Congress number (e.g., 119 for the 119th Congress). When None, defaults to the current Congress.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "law_type", + "type": "str | None", + "description": "Law type filter. Must be one of: public, private.\n\nA public law affects the general public or classes of citizens and is identified\nby a number in the format '{congress}-{number}' (e.g., '119-44'). A private law\naffects specific individuals, organizations, or localities rather than the\ngeneral public, and is far less common than public laws.", + "default": "public", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Public Law", + "value": "public" + }, + { + "label": "Private Law", + "value": "private" + } + ], + "paramName": "law_type", + "label": "Law Type" + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. When None, default sets to 100. Set to 0 for no limit.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The starting record returned. 0 is the first record.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "sort_by", + "type": "str | None", + "description": "Sort by law number. Default is highest first.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressLaws", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "law_id", + "type": "str", + "description": "The law identifier, e.g. '119-1'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Law ID", + "headerTooltip": "Click a cell here to group by this law and view it in the 'Congressional Law Viewer' widget.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "law_id" + } + } + } + }, + { + "name": "law_number", + "type": "int", + "description": "The law number within the Congress.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "law_type", + "type": "str", + "description": "The type of law (public or private).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int", + "description": "The congress session number.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "enacted_date", + "type": "date | None", + "description": "The date the law was approved/enacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The title of the law.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "citation", + "type": "str", + "description": "The public/private law citation.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "statute_citation", + "type": "str | None", + "description": "The Statutes at Large citation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "package_id", + "type": "str", + "description": "The GovInfo package identifier for the law.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pdf", + "type": "str", + "description": "URL to the law text in PDF format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "htm", + "type": "str", + "description": "URL to the law text in HTML format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "xml", + "type": "str", + "description": "URL to the law text in XML format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "CongressLaws", + "openapi_extra": { + "model": "CongressLaws" + } + }, + "/uscongress/calendars": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get House or Senate Congressional Calendar editions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.calendars(chamber='house', provider='congress_gov')\n# Get the most recent Senate calendar.\nobb.uscongress.calendars(chamber='senate', publishdate='mostrecent', provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "chamber", + "type": "str | None", + "description": "The chamber of Congress whose calendar to retrieve. Use 'both' for House and Senate editions together.", + "default": "house", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "House", + "value": "house" + }, + { + "label": "Senate", + "value": "senate" + }, + { + "label": "Both", + "value": "both" + } + ], + "paramName": "chamber", + "label": "Chamber" + } + } + }, + { + "name": "congress", + "type": "int | None", + "description": "Congress number (e.g., 119 for the 119th Congress). When None, defaults to the current Congress.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "calendar_date", + "type": "str | None", + "description": "Filter to a specific calendar date (YYYY-MM-DD), or 'mostrecent' for the latest edition. When None, returns all editions.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. When None, default sets to 100. Set to 0 for no limit.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The starting record returned. 0 is the first record.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sort_by", + "type": "str | None", + "description": "Sort by calendar date. Default is latest first.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressCalendars", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "package_id", + "type": "str", + "description": "The GovInfo package identifier for the calendar edition.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Package ID", + "headerTooltip": "Click a cell here to group by this edition and view the calendar in the 'Congressional Calendar Viewer' widget.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "package_id" + } + } + } + }, + { + "name": "calendar_date", + "type": "date", + "description": "The date of the calendar edition.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "chamber", + "type": "str", + "description": "The chamber of Congress.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int", + "description": "The congress session number.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "title", + "type": "str", + "description": "The calendar edition title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pdf", + "type": "str", + "description": "URL to the calendar in PDF format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "htm", + "type": "str", + "description": "URL to the calendar in HTML format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "xml", + "type": "str", + "description": "URL to the calendar in XML format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "CongressCalendars", + "openapi_extra": { + "model": "CongressCalendars" + } + }, + "/uscongress/mandated_reports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Congressionally Mandated Reports submitted by federal agencies.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.mandated_reports(provider='congress_gov')\n# Get the 10 most recent mandated reports for the 119th Congress.\nobb.uscongress.mandated_reports(congress=119, limit=10, provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "congress", + "type": "int | None", + "description": "Congress number (e.g., 119 for the 119th Congress). When None, defaults to the current Congress.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. When None, default sets to 100. Maximum is 1000 per request.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The starting record returned. 0 is the first record.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressMandatedReports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "package_id", + "type": "str", + "description": "The GovInfo package identifier for the report.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Package ID", + "headerTooltip": "Click a cell here to group by this report and view it in the 'Mandated Report Viewer' widget.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "package_id" + } + } + } + }, + { + "name": "publication_date", + "type": "date | None", + "description": "The date the report was published.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The report title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "submitting_agency", + "type": "str", + "description": "The agency that submitted the report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date_submitted_to_congress", + "type": "date | None", + "description": "The date the report was submitted to Congress.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date_required", + "type": "date | None", + "description": "The statutory deadline for submission to the GPO.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_on_time", + "type": "bool", + "description": "Whether the report met its submission deadline.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pdf", + "type": "str", + "description": "URL to the report in PDF format.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "details_link", + "type": "str | None", + "description": "URL to the GovInfo details page for the report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "mods_link", + "type": "str | None", + "description": "URL to the MODS metadata for the report.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "CongressMandatedReports", + "openapi_extra": { + "model": "CongressMandatedReports" + } + }, + "/uscongress/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Full-text search across congressional GovInfo collections.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.search(query='artificial intelligence', provider='congress_gov')\n# Search hearings in the 119th Congress for 'immigration'.\nobb.uscongress.search(query='immigration', collection='CHRG', congress=119, provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "query", + "type": "str", + "description": "The full-text search query.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "collection", + "type": "str | None", + "description": "Restrict to a single GovInfo collection. When None, searches all congressional collections.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All Collections", + "value": null + }, + { + "label": "Bills", + "value": "BILLS" + }, + { + "label": "Committee Reports", + "value": "CRPT" + }, + { + "label": "Hearings", + "value": "CHRG" + }, + { + "label": "Committee Prints", + "value": "CPRT" + }, + { + "label": "Congressional Record", + "value": "CREC" + }, + { + "label": "Calendars", + "value": "CCAL" + }, + { + "label": "Mandated Reports", + "value": "CMR" + }, + { + "label": "Public Laws", + "value": "PLAW" + } + ], + "label": "Collection" + } + } + }, + { + "name": "congress", + "type": "int | None", + "description": "Restrict results to a specific Congress number.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Filters by publish date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Filters by publish date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. When None, defaults to 20.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The starting record returned. 0 is the first record.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "package_id", + "type": "str", + "description": "The GovInfo package identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Package ID", + "headerTooltip": "Click a cell here to group by this document and view it in the 'Congressional Search Viewer' widget.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "package_id" + } + } + } + }, + { + "name": "date", + "type": "date | None | str", + "description": "The document publish date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "collection", + "type": "str", + "description": "The GovInfo collection code.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int | None", + "description": "The congress session number.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "citation", + "type": "str | None", + "description": "The document citation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "The document title.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "doc_url", + "type": "str", + "description": "Direct URL to the document PDF.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "CongressSearch", + "openapi_extra": { + "model": "CongressSearch" + } + }, + "/uscongress/law_text_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Resolve a law's links by law id, falling back to recent enacted laws.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.law_text_urls(provider='congress_gov', law_id='119-1', law_type='public')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "law_id", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "law_type", + "type": "str", + "description": "", + "default": "public", + "optional": true + }, + { + "name": "congress", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Law Viewer", + "description": "View the text of an enacted public or private law.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_law_viewer_congress_gov_obb", + "endpoint": "/api/v1/uscongress/bill_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/law_text_urls", + "optionsParams": { + "law_id": "$law_id", + "law_type": "$law_type", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Law Type", + "show": true, + "paramName": "law_type", + "value": "public", + "options": [ + { + "label": "Public Law", + "value": "public" + }, + { + "label": "Private Law", + "value": "private" + } + ] + }, + { + "label": "Law ID", + "description": "Group the Laws table by 'Law ID' and click a cell to load the law text.", + "show": true, + "paramName": "law_id", + "value": null + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/calendar_document_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Resolve a calendar edition's links, falling back to recent editions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.calendar_document_urls(provider='congress_gov', package_id='CCAL-119hcal-2025-01-03')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "package_id", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "congress", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Calendar Viewer", + "description": "View a House or Senate Congressional Calendar edition.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_calendar_viewer_congress_gov_obb", + "endpoint": "/api/v1/uscongress/bill_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/calendar_document_urls", + "optionsParams": { + "package_id": "$package_id", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Package ID", + "description": "The GovInfo package id. Group by 'package_id' on the source table and click a cell to load the document.", + "show": true, + "paramName": "package_id", + "value": null + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/mandated_report_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Resolve a mandated report's links, falling back to recent reports.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.mandated_report_urls(provider='congress_gov', package_id='CMR-A98-00199920')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "package_id", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "congress", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Mandated Report Viewer", + "description": "View a Congressionally Mandated Report submitted by a federal agency.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_mandated_report_viewer_congress_gov_obb", + "endpoint": "/api/v1/uscongress/bill_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/mandated_report_urls", + "optionsParams": { + "package_id": "$package_id", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Package ID", + "description": "The GovInfo package id. Group by 'package_id' on the source table and click a cell to load the document.", + "show": true, + "paramName": "package_id", + "value": null + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/search_document_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the document link for a search result, by GovInfo package id.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.search_document_urls(provider='congress_gov', package_id='CHRG-119hhrg63299')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "package_id", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Search Viewer", + "description": "View a document returned by the congressional full-text search.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_search_viewer_congress_gov_obb", + "endpoint": "/api/v1/uscongress/bill_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/search_document_urls", + "optionsParams": { + "package_id": "$package_id", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Package ID", + "description": "The GovInfo package id. Group by 'package_id' on the source table and click a cell to load the document.", + "show": true, + "paramName": "package_id", + "value": null + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/bill_text_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the available text-version document links for a bill, by bill id.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.bill_text_urls(provider='congress_gov', bill_id='119-hr-29')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "bill_id", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Bill Viewer", + "description": "View current and historical U.S. Congressional Bills.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_bill_text_congress_gov_obb", + "endpoint": "/api/v1/uscongress/bill_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/bill_text_urls", + "optionsParams": { + "bill_id": "$bill_id", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Bill ID", + "description": "Enter a bill id (e.g. '119-hr-29'), or group the 'Congressional Bills' widget by 'Bill ID' and click a cell.", + "show": true, + "paramName": "bill_id", + "value": "119-hr-1" + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/bill_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get summary, status, and other metadata for a specific bill.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.bill_info(provider='congress_gov', bill_url='https://api.congress.gov/v3/bill/119/s/1947?')\n# The bill URL can be shortened to just the bill number (e.g., '119/s/1947').\nobb.uscongress.bill_info(bill_url='119/s/1947', provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "bill_id", + "type": "str", + "description": "The bill id, e.g. '119-hr-29' (congress-billtype-number).", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Bill ID", + "description": "Enter a bill id (e.g., '119-hr-29'). Or group the 'Congressional Bills' widget by 'Bill ID' and click a cell to view this bill's summary and metadata.", + "value": "119-hr-1" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressBillInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "markdown_content", + "type": "str", + "description": "Aggregated metadata for the bill in Markdown format.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "raw_data", + "type": "dict[str, Any]", + "description": "Raw JSON data from the collected bill information.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + } + ] + }, + "model": "CongressBillInfo", + "openapi_extra": { + "model": "CongressBillInfo" + } + }, + "/uscongress/bill_text": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download the content of bill(s) from a Congress.gov file.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.bill_text(provider='congress_gov', urls=['https://www.congress.gov/119/bills/hr1/BILLS-119hr1eh.pdf'])\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "urls", + "type": "dict[str, list[str]] | list[str] | str | list[dict[str, list[str]] | list[str] | str]", + "description": "List of direct bill URLs to download. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "error_type", + "type": "str | None", + "description": "Error type if any error occurs during the download.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "content", + "type": "str", + "description": "Base64-encoded PDF document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "filename", + "type": "str | None", + "description": "The filename of the downloaded PDF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_format", + "type": "dict[str, str] | None", + "description": "Data format information, including data type and filename.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CongressBillText", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "CongressBillText" + } + }, + "/uscongress/amendments": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get and filter lists of Congressional Amendments.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.amendments(provider='congress_gov')\nobb.uscongress.amendments(congress=119, amendment_type='hamdt', provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "congress", + "type": "int | None", + "description": "Congress number (e.g., 119 for the 119th Congress). When None, defaults to the current Congress.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "amendment_type", + "type": "str | None", + "description": "Amendment type (e.g., 'hamdt' for House Amendments).\n\nMust be one of:\n\n- hamdt: An amendment offered or adopted in the House of Representatives.\nHouse amendments are identified by 'H.Amdt.' followed by a number.\n- samdt: An amendment offered or adopted in the Senate.\nSenate amendments are identified by 'S.Amdt.' followed by a number.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "House Amendment", + "value": "hamdt" + }, + { + "label": "Senate Amendment", + "value": "samdt" + } + ], + "value": null, + "style": { + "popupWidth": 200 + }, + "paramName": "amendment_type", + "label": "Amendment Type" + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Filter amendments updated on or after this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Filter amendments updated on or before this date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of results to return. When None, defaults to 100 (max 250). Set to 0 for no limit (must be used with 'amendment_type').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "offset", + "type": "int | None", + "description": "The starting record returned. 0 is the first record.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "sort_by", + "type": "str | None", + "description": "Sort by update date. Default is latest first.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressAmendments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "amendment_id", + "type": "str", + "description": "The amendment identifier, e.g. '119-hamdt-2'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Amendment ID", + "headerTooltip": "Click a cell here to group by this amendment and view it in the 'Congressional Amendment Info' / 'Congressional Amendment Viewer' widgets.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "amendment_id" + } + } + } + }, + { + "name": "submitted_date", + "type": "date | None", + "description": "The date the amendment was submitted.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Submitted" + } + } + }, + { + "name": "latest_action_date", + "type": "date | None", + "description": "The date of the latest action.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int", + "description": "The congress session number.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "amendment_type", + "type": "str", + "description": "The type of amendment (e.g., HAMDT, SAMDT).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Type" + } + } + }, + { + "name": "number", + "type": "str", + "description": "The amendment number.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none", + "headerName": "Amendment No." + } + } + }, + { + "name": "amended_bill", + "type": "str | None", + "description": "The bill being amended (e.g., 'HR 1234' or 'S 456').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amended_bill_title", + "type": "str | None", + "description": "The title of the bill being amended.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Bill Title" + } + } + }, + { + "name": "sponsor", + "type": "str | None", + "description": "The primary sponsor of the amendment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_action", + "type": "str | None", + "description": "Latest action text.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "A short description of the amendment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "purpose", + "type": "str | None", + "description": "The purpose of the amendment.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "update_date", + "type": "date | None", + "description": "The date the record was last updated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_action_time", + "type": "str | None", + "description": "The time of the latest action.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "CongressAmendments", + "openapi_extra": { + "model": "CongressAmendments" + } + }, + "/uscongress/amendment_text_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the Congressional Record document links for an amendment, by amendment id.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.amendment_text_urls(provider='congress_gov', amendment_id='119-hamdt-2')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "amendment_id", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Amendment Viewer", + "description": "View Congressional Record documents for a U.S. Amendment.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_amendment_text_congress_gov_obb", + "endpoint": "/api/v1/uscongress/amendment_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/amendment_text_urls", + "optionsParams": { + "amendment_id": "$amendment_id", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Amendment ID", + "description": "Enter an amendment id (e.g. '119-hamdt-2'), or group the 'Congressional Amendments' widget by 'Amendment ID' and click a cell.", + "show": true, + "paramName": "amendment_id", + "value": "119-hamdt-2" + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/amendment_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get details for a specific amendment.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.amendment_info(provider='congress_gov', amendment_id='119-hamdt-2')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "amendment_id", + "type": "str", + "description": "The amendment id, e.g. '119-hamdt-2' (congress-type-number).", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Amendment ID", + "description": "Enter an amendment id (e.g., '119-hamdt-2'). Or group the 'Congressional Amendments' widget by 'Amendment ID' and click a cell to view this amendment's details.", + "value": "119-hamdt-2" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressAmendmentInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "markdown_content", + "type": "str", + "description": "Aggregated metadata for the amendment in Markdown format.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "raw_data", + "type": "dict[str, Any]", + "description": "Raw JSON data from the collected amendment information.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + } + ] + }, + "model": "CongressAmendmentInfo", + "openapi_extra": { + "model": "CongressAmendmentInfo" + } + }, + "/uscongress/amendment_text": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download amendment document(s) from Congress.gov.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.amendment_text(provider='congress_gov', urls=['https://www.govinfo.gov/content/pkg/CREC-2022-03-24/pdf/CREC-2022-03-24-pt1-PgS1778-4.pdf'])\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "urls", + "type": "dict[str, list[str]] | list[str] | str | list[dict[str, list[str]] | list[str] | str]", + "description": "List of direct amendment document URLs to download. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "error_type", + "type": "str | None", + "description": "Error type if any error occurs during the download.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "content", + "type": "str", + "description": "Base64-encoded PDF document or plain text content.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "filename", + "type": "str | None", + "description": "The filename of the downloaded document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_format", + "type": "dict[str, str] | None", + "description": "Data format information, including data type and filename.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CongressAmendmentText", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "CongressAmendmentText" + } + }, + "/uscongress/committee_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get metadata and membership for a single U.S. Congressional Committee.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.committee_info(chamber='senate', committee='ssaf00', provider='congress_gov')\nobb.uscongress.committee_info(chamber='house', committee='hsju00', provider='congress_gov')\n# Get info for a subcommittee.\nobb.uscongress.committee_info(chamber='senate', committee='ssga00', subcommittee='ssga22', provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "chamber", + "type": "str | None", + "description": "Chamber: house, senate, or joint.", + "default": "senate", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Chamber", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "congress": "$congress", + "is_workspace": true + } + } + } + }, + { + "name": "committee", + "type": "str | None", + "description": "System code of the committee (e.g., ssaf00, hsju00).", + "default": "ssaf00", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Committee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "congress": "$congress", + "is_workspace": true + }, + "style": { + "popupWidth": 700 + }, + "row": 1 + } + } + }, + { + "name": "subcommittee", + "type": "str | None", + "description": "System code of a subcommittee (e.g., ssga22). Leave empty for parent committee.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Subcommittee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "committee": "$committee", + "subcommittees": true, + "is_workspace": true + }, + "style": { + "popupWidth": 750 + }, + "row": 1 + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressCommitteeInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "markdown_content", + "type": "str", + "description": "Committee metadata and membership formatted as Markdown.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "raw_data", + "type": "dict[str, Any]", + "description": "Raw JSON data from the committee detail and member lookups.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "exclude": true + } + } + } + ] + }, + "model": "CongressCommitteeInfo", + "openapi_extra": { + "model": "CongressCommitteeInfo" + } + }, + "/uscongress/committee_documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get documents (reports, hearings, prints, meetings) produced by a single Congressional Committee.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get reports from the Senate Agriculture Committee.\nobb.uscongress.committee_documents(chamber='senate', committee='ssaf00', doc_type='report', provider='congress_gov')\n# Get hearings from the House Judiciary Committee for the 119th Congress.\nobb.uscongress.committee_documents(chamber='house', committee='hsju00', doc_type='meeting', congress=119, provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "congress", + "type": "int | None", + "description": "Congress number (e.g., 119). Defaults to the current Congress.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Congress", + "type": "number" + } + } + }, + { + "name": "chamber", + "type": "str | None", + "description": "Chamber: house, senate, or joint.", + "default": "senate", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Chamber", + "options": [ + { + "label": "Senate", + "value": "senate" + }, + { + "label": "House", + "value": "house" + }, + { + "label": "Joint", + "value": "joint" + } + ], + "value": "senate" + } + } + }, + { + "name": "committee", + "type": "str | None", + "description": "System code of the committee (e.g., ssaf00, hsju00).", + "default": "ssaf00", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Committee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "congress": "$congress", + "is_workspace": true + }, + "value": "ssaf00", + "style": { + "popupWidth": 750 + }, + "row": 1 + } + } + }, + { + "name": "subcommittee", + "type": "str | None", + "description": "System code of a subcommittee (e.g., ssga22). Leave empty for parent committee.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Subcommittee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "committee": "$committee", + "subcommittees": true, + "is_workspace": true + }, + "style": { + "popupWidth": 750 + }, + "row": 1 + } + } + }, + { + "name": "doc_type", + "type": "str | None", + "description": "Type of committee document to retrieve. Options: all (default), report, meeting, publication, legislation.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "All", + "value": "all" + }, + { + "label": "Reports", + "value": "report" + }, + { + "label": "Meetings & Hearings", + "value": "meeting" + }, + { + "label": "Publications & Prints", + "value": "publication" + }, + { + "label": "Legislation", + "value": "legislation" + } + ], + "value": "all", + "paramName": "doc_type", + "label": "Document Type", + "style": { + "popupWidth": 220 + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. Maximum 250.", + "default": 250, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "offset", + "type": "int | None", + "description": "Pagination offset.", + "default": 0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressCommitteeDocuments", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "citation", + "type": "str | None", + "description": "Official citation (e.g., 'H. Rept. 119-5' or 'S. Hrg. 119-74').", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "date", + "type": "date | None | str", + "description": "The document date (report/hearing/print date).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "doc_type", + "type": "str", + "description": "Document type (report, meeting, publication).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "chamber", + "type": "str | None", + "description": "Chamber (House, Senate, Joint).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int | None", + "description": "Congress session number.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "title", + "type": "str | None", + "description": "Document title.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "package_id", + "type": "str | None", + "description": "The GovInfo package identifier for the document.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "doc_url", + "type": "str | None", + "description": "Direct URL to the document PDF.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "CongressCommitteeDocuments", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "CongressCommitteeDocuments" + } + }, + "/uscongress/committee_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get committee or subcommittee choices for cascading dropdowns.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "chamber", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "congress", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "committee", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "subcommittees", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/uscongress/committee_document_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get document choices for a Congressional Committee.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.committee_document_urls(provider='congress_gov', chamber='senate', committee='ssaf00')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "chamber", + "type": "str", + "description": "", + "default": null, + "optional": false + }, + { + "name": "committee", + "type": "str", + "description": "", + "default": null, + "optional": false + }, + { + "name": "subcommittee", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "doc_type", + "type": "str", + "description": "", + "default": "all", + "optional": true + }, + { + "name": "congress", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Committee Document Viewer", + "description": "Browse and view documents for a U.S. Congressional Committee.", + "category": "Government", + "subCategory": "Congress", + "type": "multi_file_viewer", + "widgetId": "uscongress_committee_document_viewer_congress_gov_obb", + "endpoint": "/api/v1/uscongress/bill_text", + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_document_urls", + "optionsParams": { + "chamber": "$chamber", + "committee": "$committee", + "subcommittee": "$subcommittee", + "doc_type": "$doc_type", + "congress": "$congress", + "is_workspace": true + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "is_workspace", + "value": true, + "show": false + }, + { + "label": "Congress", + "description": "Congress number (e.g. 119).", + "show": true, + "paramName": "congress", + "value": 119, + "type": "number" + }, + { + "label": "Chamber", + "show": true, + "paramName": "chamber", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "congress": "$congress", + "is_workspace": true + } + }, + { + "label": "Committee", + "show": true, + "paramName": "committee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "congress": "$congress", + "is_workspace": true + }, + "style": { + "popupWidth": 750 + } + }, + { + "label": "Subcommittee", + "show": true, + "paramName": "subcommittee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "committee": "$committee", + "subcommittees": true, + "is_workspace": true + }, + "style": { + "popupWidth": 750 + } + }, + { + "label": "Document Type", + "description": "Type of committee document to browse.", + "show": true, + "paramName": "doc_type", + "value": "meeting", + "options": [ + { + "label": "Reports", + "value": "report" + }, + { + "label": "Meetings & Hearings", + "value": "meeting" + }, + { + "label": "Publications & Prints", + "value": "publication" + }, + { + "label": "Legislation", + "value": "legislation" + } + ] + } + ], + "refetchInterval": false + }, + "model": "" + } + }, + "/uscongress/committee_members_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a committee's current membership with each member's profile.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "chamber", + "type": "str", + "description": "Chamber the committee belongs to.", + "default": "senate", + "optional": true + }, + { + "name": "committee", + "type": "str", + "description": "Committee system code.", + "default": "ssaf00", + "optional": true + }, + { + "name": "subcommittee", + "type": "str", + "description": "Subcommittee system code. Takes precedence over the committee.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/uscongress/committee_members": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render a committee's members as cards (OpenBB Workspace iframe widget).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "chamber", + "type": "str", + "description": "", + "default": "senate", + "optional": true + }, + { + "name": "committee", + "type": "str", + "description": "", + "default": "ssaf00", + "optional": true + }, + { + "name": "subcommittee", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Committee Members", + "description": "Member cards for a U.S. Congressional Committee.", + "category": "Government", + "subCategory": "Congress", + "type": "iframe", + "widgetId": "uscongress_committee_members_congress_gov_obb", + "params": [ + { + "label": "Chamber", + "show": true, + "paramName": "chamber", + "value": "house", + "options": [ + { + "label": "Senate", + "value": "senate" + }, + { + "label": "House", + "value": "house" + }, + { + "label": "Joint", + "value": "joint" + } + ] + }, + { + "label": "Committee", + "show": true, + "paramName": "committee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "is_workspace": true + }, + "value": "hsju00", + "style": { + "popupWidth": 700 + } + }, + { + "label": "Subcommittee", + "show": true, + "paramName": "subcommittee", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/committee_choices", + "optionsParams": { + "chamber": "$chamber", + "committee": "$committee", + "subcommittees": true, + "is_workspace": true + }, + "style": { + "popupWidth": 750 + } + }, + { + "paramName": "theme", + "show": false + } + ], + "refetchInterval": false + } + } + }, + "/uscongress/members": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get and filter the current members of the U.S. Congress.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.members(provider='congress_gov')\nobb.uscongress.members(chamber='house', state='OH', provider='congress_gov')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "chamber", + "type": "str | None", + "description": "Filter members by chamber. When None, returns both chambers.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "House", + "value": "house" + }, + { + "label": "Senate", + "value": "senate" + } + ], + "paramName": "chamber", + "label": "Chamber" + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Filter members by two-letter state/territory code (e.g., 'OH').", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Alabama", + "value": "AL" + }, + { + "label": "Alaska", + "value": "AK" + }, + { + "label": "Arizona", + "value": "AZ" + }, + { + "label": "Arkansas", + "value": "AR" + }, + { + "label": "California", + "value": "CA" + }, + { + "label": "Colorado", + "value": "CO" + }, + { + "label": "Connecticut", + "value": "CT" + }, + { + "label": "Delaware", + "value": "DE" + }, + { + "label": "Florida", + "value": "FL" + }, + { + "label": "Georgia", + "value": "GA" + }, + { + "label": "Hawaii", + "value": "HI" + }, + { + "label": "Idaho", + "value": "ID" + }, + { + "label": "Illinois", + "value": "IL" + }, + { + "label": "Indiana", + "value": "IN" + }, + { + "label": "Iowa", + "value": "IA" + }, + { + "label": "Kansas", + "value": "KS" + }, + { + "label": "Kentucky", + "value": "KY" + }, + { + "label": "Louisiana", + "value": "LA" + }, + { + "label": "Maine", + "value": "ME" + }, + { + "label": "Maryland", + "value": "MD" + }, + { + "label": "Massachusetts", + "value": "MA" + }, + { + "label": "Michigan", + "value": "MI" + }, + { + "label": "Minnesota", + "value": "MN" + }, + { + "label": "Mississippi", + "value": "MS" + }, + { + "label": "Missouri", + "value": "MO" + }, + { + "label": "Montana", + "value": "MT" + }, + { + "label": "Nebraska", + "value": "NE" + }, + { + "label": "Nevada", + "value": "NV" + }, + { + "label": "New Hampshire", + "value": "NH" + }, + { + "label": "New Jersey", + "value": "NJ" + }, + { + "label": "New Mexico", + "value": "NM" + }, + { + "label": "New York", + "value": "NY" + }, + { + "label": "North Carolina", + "value": "NC" + }, + { + "label": "North Dakota", + "value": "ND" + }, + { + "label": "Ohio", + "value": "OH" + }, + { + "label": "Oklahoma", + "value": "OK" + }, + { + "label": "Oregon", + "value": "OR" + }, + { + "label": "Pennsylvania", + "value": "PA" + }, + { + "label": "Rhode Island", + "value": "RI" + }, + { + "label": "South Carolina", + "value": "SC" + }, + { + "label": "South Dakota", + "value": "SD" + }, + { + "label": "Tennessee", + "value": "TN" + }, + { + "label": "Texas", + "value": "TX" + }, + { + "label": "Utah", + "value": "UT" + }, + { + "label": "Vermont", + "value": "VT" + }, + { + "label": "Virginia", + "value": "VA" + }, + { + "label": "Washington", + "value": "WA" + }, + { + "label": "West Virginia", + "value": "WV" + }, + { + "label": "Wisconsin", + "value": "WI" + }, + { + "label": "Wyoming", + "value": "WY" + }, + { + "label": "District of Columbia", + "value": "DC" + }, + { + "label": "American Samoa", + "value": "AS" + }, + { + "label": "Guam", + "value": "GU" + }, + { + "label": "Northern Mariana Islands", + "value": "MP" + }, + { + "label": "Puerto Rico", + "value": "PR" + }, + { + "label": "U.S. Virgin Islands", + "value": "VI" + } + ], + "paramName": "state", + "label": "State" + } + } + }, + { + "name": "party", + "type": "str | None", + "description": "Filter members by party (Democrat, Republican, Independent).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Democrat", + "value": "Democrat" + }, + { + "label": "Republican", + "value": "Republican" + }, + { + "label": "Independent", + "value": "Independent" + } + ], + "paramName": "party", + "label": "Party" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressMembers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "bioguide_id", + "type": "str", + "description": "The member's Biographical Directory (bioguide) identifier.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Bioguide ID", + "headerTooltip": "Click a cell here to group by this member and view them in the 'Member Info' / 'Member Votes' / 'Member Legislation' widgets.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "bioguide_id" + } + } + } + }, + { + "name": "name", + "type": "str", + "description": "The member's full name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "chamber", + "type": "str", + "description": "The chamber the member serves in.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "party", + "type": "str", + "description": "The member's party.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str", + "description": "The member's state or territory.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "district", + "type": "int | None", + "description": "The House district number (None for senators).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "term_start", + "type": "date | None", + "description": "The start date of the member's current term.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "term_end", + "type": "date | None", + "description": "The end date of the member's current term.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "The member's official website.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CongressMembers", + "openapi_extra": { + "model": "CongressMembers" + } + }, + "/uscongress/member_info_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a member's bio, contact, links, committees, terms, and voting record.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "bioguide_id", + "type": "str", + "description": "Bioguide id of a current member of Congress.", + "default": "A000055", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/uscongress/member_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render a member's bio, history, and committees (OpenBB Workspace iframe widget).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "bioguide_id", + "type": "str", + "description": "", + "default": "A000055", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Congressional Member Info", + "description": "Bio, history, and committee assignments for a member.", + "category": "Government", + "subCategory": "Congress", + "type": "iframe", + "widgetId": "uscongress_member_info_congress_gov_obb", + "params": [ + { + "label": "Member", + "show": true, + "paramName": "bioguide_id", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/member_choices", + "optionsParams": { + "is_workspace": true + }, + "value": "A000055", + "style": { + "popupWidth": 400 + } + }, + { + "paramName": "theme", + "show": false + } + ], + "refetchInterval": false + } + } + }, + "/uscongress/member_votes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a member's roll-call votes on legislation, House and Senate.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.member_votes(provider='congress_gov', bioguide_id='A000055')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "bioguide_id", + "type": "str", + "description": "The member's Biographical Directory (bioguide) identifier.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Member", + "description": "Select a member, or group the 'Congressional Members' widget by 'Bioguide ID' and click a cell to view their votes.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/member_choices", + "optionsParams": { + "is_workspace": true + }, + "value": "A000055", + "style": { + "popupWidth": 400 + } + } + } + }, + { + "name": "congress", + "type": "int | None", + "description": "Restrict to a single Congress. When None, spans the member's full voting history across both chambers (newest first).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of most recent roll-call votes to return.", + "default": 25, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressMemberVotes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "bill_id", + "type": "str", + "description": "The bill or resolution voted on, e.g. '119-hr-2913'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "congress", + "type": "int", + "description": "The Congress in which the vote was cast.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "chamber", + "type": "str", + "description": "The chamber the vote was cast in.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "The title/description of the measure voted on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legislation", + "type": "str | None", + "description": "The measure as identified by Voteview.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | None | str", + "description": "The date of the vote.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "position", + "type": "str", + "description": "The member's recorded position.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "rollnumber", + "type": "int", + "description": "The roll-call number within the Congress/chamber.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "question", + "type": "str | None", + "description": "The vote question.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "result", + "type": "str | None", + "description": "The overall vote result.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CongressMemberVotes", + "openapi_extra": { + "model": "CongressMemberVotes" + } + }, + "/uscongress/member_legislation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the bills a member sponsored or cosponsored in a Congress.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.uscongress.member_legislation(provider='congress_gov', bioguide_id='A000055')\n```\n\n", + "parameters": { + "standard": [], + "congress_gov": [ + { + "name": "bioguide_id", + "type": "str", + "description": "The member's Biographical Directory (bioguide) identifier.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Member", + "description": "Select a member, or group the 'Congressional Members' widget by 'Bioguide ID' and click a cell to view legislation.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/uscongress/member_choices", + "optionsParams": { + "is_workspace": true + }, + "value": "A000055", + "style": { + "popupWidth": 400 + } + } + } + }, + { + "name": "congress", + "type": "int | None", + "description": "Restrict to a single Congress (e.g., 119). When None, spans the member's full history across every Congress they served (back to the 108th, the earliest with bulk data).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "number" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CongressMemberLegislation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "congress_gov": [ + { + "name": "bill_id", + "type": "str", + "description": "The bill identifier, e.g. '119-hr-29'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "introduced_date", + "type": "date | None", + "description": "The date the bill was introduced.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_action_date", + "type": "date | None", + "description": "The date of the latest action on the bill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "congress", + "type": "int", + "description": "The Congress the bill belongs to.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "formatterFn": "none" + } + } + }, + { + "name": "role", + "type": "str", + "description": "Whether the member is the sponsor or a cosponsor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "The title of the bill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_action", + "type": "str | None", + "description": "The latest action on the bill.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CongressMemberLegislation", + "openapi_extra": { + "model": "CongressMemberLegislation" + } + }, + "/uscongress/member_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get bioguide picker choices for the member widgets.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "chamber", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "congress_gov", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/uscongress/how_to_use": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return a tab's 'How To Use' note as Markdown (OpenBB Workspace markdown widget).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "note", + "type": "str", + "description": "", + "default": "bills", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "How To Use", + "description": "Usage notes for the U.S. Congress app tabs.", + "category": "Government", + "subCategory": "Congress", + "type": "markdown", + "widgetId": "uscongress_how_to_use_congress_gov_obb", + "data": { + "dataKey": "" + }, + "params": [ + { + "paramName": "note", + "value": "bills", + "show": false + } + ], + "refetchInterval": false + } + } + }, + "/usda/ers_viz_catalog": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the USDA ERS Tableau Public visualizations.\n\n Returns\n -------\n list", + "examples": "", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/ers_chart": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render an embedded USDA ERS Tableau Public visualization (OpenBB Workspace iframe widget).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "viz", + "type": "str", + "description": "", + "default": "Marketbaskets/Marketbaskets", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "USDA ERS Interactive Charts", + "description": "Interactive data visualizations published by the USDA Economic Research Service on Tableau Public.", + "category": "Economy", + "subCategory": "Agriculture", + "source": [ + "USDA", + "ERS" + ], + "type": "iframe", + "widgetId": "usda_ers_chart_usda_obb", + "gridData": { + "w": 40, + "h": 30 + }, + "params": [ + { + "label": "Visualization", + "show": true, + "paramName": "viz", + "value": "Marketbaskets/Marketbaskets", + "type": "text", + "options": [ + { + "label": "2014 Tenure, Ownership, and Transition of Agricultural Land (TOTAL) survey", + "value": "2014TenureOwnershipandTransitionofAgriculturalLandTOTALsurvey/TOTALStory" + }, + { + "label": "A Closer Look at Retail Food Spending and Price Environment", + "value": "ACloserLookatRetailFoodSpendingandPriceEnvironment/FPEStory" + }, + { + "label": "Annual Value of State Exports", + "value": "Valueof2017StateExports/Dashboard1" + }, + { + "label": "Average share of exports in U.S. agricultural production", + "value": "AverageshareofexportsinU_S_agriculturalproduction/AvgshareofEXPAgprod" + }, + { + "label": "Average share of imports in U.S. consumption", + "value": "AverageshareofimportsinU_S_consumption/AvgshareofIMPAgprod" + }, + { + "label": "Changes in farm values can affect retail prices", + "value": "Changesinfarmvaluescanaffectretailprices/Changesinfarmvaluescanaffectretailprices" + }, + { + "label": "Commodity Costs and Returns: Crops", + "value": "U_S_CommodityCostsandReturns/CommodityCostsandReturns" + }, + { + "label": "Commodity Costs and Returns: Livestock and Milk", + "value": "CommodityCostsandReturnsLivestockandMilk/CommodityCostsandReturnsLivestockandMilk" + }, + { + "label": "Consecutive decades of high poverty since 1960 in U.S. counties", + "value": "Consecutivedecadesofhighpovertysince1960inU_S_counties/Consecutivehighpovertyareas" + }, + { + "label": "Dietary Recommendations and Calorie Consumption", + "value": "DietaryRecommendationsandCalorieConsumption/DietaryRecomandCalorieCon" + }, + { + "label": "Digging Into the U.S. Farm Balance Sheet", + "value": "BalanceSheetStoryPoint2/BalanceSheet" + }, + { + "label": "Estimated U.S. poultry and red meat disappearance per capita by year", + "value": "EstimatedU_S_poultryandredmeatdisappearancepercapitabyyear/Dissappearance" + }, + { + "label": "Exports of bulk and high-value commodities", + "value": "Exportsofbulkandhigh-valuecommodities/XPBlkvsHVP" + }, + { + "label": "Farm share of retail price varies across food products", + "value": "Farmshareofretailpricevariesacrossfoodproducts/Farmshareofretailpricevariesacrossfoodproducts" + }, + { + "label": "Food Security in the United States: How Do States Compare?", + "value": "FoodSecurityintheUnitedStatesHowDoStatesCompare/mainstory" + }, + { + "label": "Fruit and Vegetable Availability", + "value": "FruitandVegetableAvailability/FruitVegetableStory" + }, + { + "label": "Fruit and vegetable costs per cup equivalent: Cost ranges", + "value": "FruitandvegetablecostspercupequivalentCostranges/BoxPlotsStory3" + }, + { + "label": "Fruit and vegetable retail prices: Most and least expensive", + "value": "FruitandvegetableretailpricesMostandleastexpensive/MostLeastStory2" + }, + { + "label": "Fruits and Vegetable Costs per Edible Cup Equivalent", + "value": "FruitsandVegetableCostsperEdibleCupEquivalent/CostsStory1" + }, + { + "label": "Get to know your State", + "value": "Gettoknowyourstate2/State-leveldashboard" + }, + { + "label": "Global cotton supply and use", + "value": "Globalcottonsupplyanduse/Dashboard3" + }, + { + "label": "Imports of bulk and high-value commodities", + "value": "Importsofbulkandhigh-valuecommodities/IMPBlkvsHVP" + }, + { + "label": "International Baseline Projections", + "value": "InternationalBaselineProjections/Internationalbaselinevisualization" + }, + { + "label": "Major Uses of Land in the United States, 2012", + "value": "MajorUsesofLandintheUnitedStates2012/MajorLandUse2012" + }, + { + "label": "Market Baskets", + "value": "Marketbaskets/Marketbaskets" + }, + { + "label": "Meeting honey demand in the United States", + "value": "MeetinghoneydemandintheUnitedStates/HoneyDemand" + }, + { + "label": "National Food Expenditure Series", + "value": "NationalFoodExpenditureSeries/National" + }, + { + "label": "National Household Food Acquisition and Purchase Survey Food Expenditures", + "value": "NationalHouseholdFoodAcquisitionandPurchaseSurveyFoodExpenditures/FoodAPSDataViz" + }, + { + "label": "Percentage change in UK agricultural exports and imports", + "value": "PercentagechangeinUKagriculturalexportsandimports/Growthrate" + }, + { + "label": "Persistent poverty and high poverty U.S. counties", + "value": "PersistentpovertyandhighpovertyU_S_counties/PersistentandHighPovertyDashboard" + }, + { + "label": "Prevalence and distribution of food insecurity by education status", + "value": "Prevalenceanddistributionoffoodinsecuritybyeducationstatus/Story2" + }, + { + "label": "Price spreads for individual food products", + "value": "Pricespreadsforindividualfoodproducts/Pricespreadsforindividualfoodproducts" + }, + { + "label": "Shares of different regions in U.S. agricultural exports", + "value": "SharesofdifferentregionsinU_S_agriculturalexports/SharesofdifferentregionsinUSagriculturalexports" + }, + { + "label": "SNAP Policy Index: Eligibility", + "value": "SNAPPolicyIndexEligibility/Eligibilty" + }, + { + "label": "SNAP Policy Index: Outreach", + "value": "SNAPPolicyIndexOutreach/Outreach" + }, + { + "label": "SNAP Policy Index: Overview", + "value": "SNAPPolicyIndexOverview/Overview" + }, + { + "label": "SNAP Policy Index: Stigma", + "value": "SNAPPolicyIndexStigma/Stigma" + }, + { + "label": "SNAP Policy Index: Transaction costs", + "value": "SNAPPolicyIndexTransactioncosts/Transaction" + }, + { + "label": "State Food Expenditure Series", + "value": "StateFoodExpenditureSeries/State" + }, + { + "label": "State-Level Estimates of Low Income and Low Access Populations", + "value": "State-LevelEstimatesofLowIncomeandLowAccessPopulations/FinalWide" + }, + { + "label": "Statistical summary of the poultry and eggs sector", + "value": "StatisticalsummaryofthePoultryandEggsSector/tableAndLineGraph" + }, + { + "label": "The Farm Income Atlas", + "value": "IncomeStatementStoryPoint3/Incomestatement" + }, + { + "label": "Trends in agricultural outputs, inputs, and total factor productivity (TFP) by country income group, 1961\u20132023", + "value": "TrendsinagriculturaloutputsinputsandtotalfactorproductivityTFPbycountryincomegroup19612023/AgriculturalTFPChart" + }, + { + "label": "Trends in food insecurity in U.S. households with children", + "value": "TrendsinfoodinsecurityinU_S_householdswithchildren/FoodSecurityCharacteristics" + }, + { + "label": "Trends in U.S. food security", + "value": "TrendsinU_S_FoodSecurity/FoodSecurityCharacteristics" + }, + { + "label": "U.S. Agricultural Baseline Projections", + "value": "U_S_AgriculturalBaselineProjections/Projections" + }, + { + "label": "U.S. agricultural exports supported jobs outside farming", + "value": "U_S_agriculturalexportssupportedjobsoutsidefarming/XPJobSupport" + }, + { + "label": "U.S. agricultural exports to the UK by product", + "value": "U_S_agriculturalexportstotheUKbyproduct/USagexports" + }, + { + "label": "U.S. county poverty rates", + "value": "U_S_countypovertyrates/Povertydashboardorig" + }, + { + "label": "U.S. export values per region", + "value": "U_S_exportvaluesperregion/XPbyregionbar" + }, + { + "label": "U.S. Farmer Household Wellbeing", + "value": "U_S_FarmerHouseholdWellbeing/OVERVIEW-FullWidth" + }, + { + "label": "U.S. food system resource use by supply chain stage", + "value": "U_S_foodsystemresourceusebysupplychainstage/RRFDFigure2" + }, + { + "label": "U.S. food system\u2019s share of national resource use", + "value": "U_S_foodsystemsshareofnationalresourceuse/RRFDFigure1" + }, + { + "label": "U.S. food-at-home resource use by category", + "value": "U_S_food-at-homeresourceusebycategory/RRFDFigure3" + }, + { + "label": "U.S. per capita food availability for additional commodities", + "value": "U_S_percapitafoodavailabilityforadditionalcommodities/PerCapitaStory2" + }, + { + "label": "U.S. per capita food availability for selected commodities", + "value": "U_S_percapitafoodavailabilityforselectedcommodities/PerCapitaStory1" + }, + { + "label": "U.S. source and destination shares", + "value": "U_S_sourceanddestinationshares/USImpExpShares" + }, + { + "label": "U.S. State-level poultry sales for major commodities", + "value": "U_S_State-levelpoultrysalesformajorcommodities/Map" + }, + { + "label": "UK agricultural imports and exports", + "value": "UKagriculturalimportsandexports/UKimports" + }, + { + "label": "Vegetables and pulses: commodity highlights", + "value": "Vegetablesandpulsescommodityhighlights/Story1" + }, + { + "label": "Wheat Data Visualization", + "value": "WheatDataVisualization/U_S_Overview" + }, + { + "label": "World Agricultural Supply and Demand Estimates at a Glance", + "value": "WorldAgriculturalSupplyandDemandEstimatesataGlance/MAIN_STORY" + } + ], + "style": { + "popupWidth": 600 + } + }, + { + "paramName": "theme", + "show": false + } + ], + "refetchInterval": false + } + } + }, + "/usda/price_spreads": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS price spreads from farm to consumer - retail price versus farm value for food items and market baskets.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.price_spreads(provider='usda')\n# Get the milk and dairy market basket alongside whole milk, from 2015.\nobb.usda.price_spreads(item='milk_and_dairy_basket,whole_milk', start_year=2015, provider='usda')\n# Get every fresh vegetable series.\nobb.usda.price_spreads(category='fresh_vegetables', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "category", + "type": "str | None", + "description": "Filter items by data product category. If None, all categories are included.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Category", + "value": "dairy", + "options": [ + { + "label": "Dairy", + "value": "dairy" + }, + { + "label": "Fresh fruit", + "value": "fresh_fruit" + }, + { + "label": "Fresh vegetables", + "value": "fresh_vegetables" + }, + { + "label": "Processed", + "value": "processed" + }, + { + "label": "Field crops", + "value": "field_crops" + } + ] + } + } + }, + { + "name": "item", + "type": "str | None | list[str | None]", + "description": "Item(s) to retrieve, as a comma-separated list of slugs. If None, all items are returned. Valid items are:\n butter, cheddar_cheese, flour, fresh_apples, fresh_broccoli, fresh_carrots, fresh_fruit_basket, fresh_grapefruit, fresh_grapes, fresh_lettuce_iceberg, fresh_lettuce_romaine, fresh_oranges, fresh_peaches, fresh_potatoes, fresh_strawberries, fresh_tomatoes, fresh_vegetables_basket, ice_cream, milk_and_dairy_basket, orange_juice_nfc, sugar, vegetable_oil, white_pan_bread, whole_milk Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Item", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": "whole_milk", + "optionsEndpoint": "/api/v1/usda/price_spread_items", + "optionsParams": { + "category": "$category" + }, + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. None returns from the beginning of each series. Marketing-year series filter on the first year of the marketing year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year. Marketing-year series filter on the first year of the marketing year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FarmToConsumerPriceSpreads", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity name, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "pinned": "left" + } + } + }, + { + "name": "category", + "type": "str", + "description": "Data product category of the item.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Category", + "hide": true + } + } + }, + { + "name": "year", + "type": "int", + "description": "Calendar year of the observation. For marketing-year series, the first year of the marketing year.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "maxWidth": 90 + } + } + }, + { + "name": "marketing_year", + "type": "str | None", + "description": "Marketing year of the observation, as published, e.g. '2024/25'. Only present for marketing-year series.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Marketing year", + "hide": true + } + } + }, + { + "name": "retail_price", + "type": "float | None", + "description": "Retail price, in dollars per published unit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail price", + "cellDataType": "number" + } + } + }, + { + "name": "farm_value", + "type": "float | None", + "description": "Farm value, in dollars per published unit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farm value", + "cellDataType": "number" + } + } + }, + { + "name": "farm_price", + "type": "float | None", + "description": "Farm price, in dollars per published unit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farm price", + "cellDataType": "number" + } + } + }, + { + "name": "farm_share", + "type": "float | None", + "description": "Farm share of the retail price, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farm share %", + "cellDataType": "number" + } + } + }, + { + "name": "retail_cost_index", + "type": "float | None", + "description": "Retail cost index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail cost index", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "farm_value_index", + "type": "float | None", + "description": "Farm value index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farm value index", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "farm_to_retail_spread_index", + "type": "float | None", + "description": "Farm-to-retail spread index.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Spread index", + "cellDataType": "number", + "hide": true + } + } + } + ] + }, + "model": "FarmToConsumerPriceSpreads", + "openapi_extra": { + "model": "FarmToConsumerPriceSpreads" + } + }, + "/usda/price_spread_items": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List price-spread items, narrowed to a category when provided.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "category", + "type": "str", + "description": "Data product category. When None, every item is returned.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/milk_cost_items": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List milk cost items, narrowed to a cost category when provided.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "report", + "type": "str", + "description": "Report key, by_state or by_size_of_operation.", + "default": "by_state", + "optional": true + }, + { + "name": "category", + "type": "str", + "description": "Cost category key. When None, every item is returned.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/bell_report_commodities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the commodities available for the Bell Report.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/bell_report_weeks": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the published period ending dates for the Bell Report.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "", + "default": 260, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/bell_report_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the downloadable Bell Reports for a commodity and period.\n\n One entry per marketing year report. Only published periods are\n offered, so an embargoed report is never addressable.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity_code", + "type": "str", + "description": "", + "default": "101", + "optional": true + }, + { + "name": "week_ending", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/bell_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download one, or more, USDA FAS Bell Reports.\n\nThis command returns only the results portion of the OBBject response.\nIt contains a list of dictionaries where the base64 encoded content of the\ndocument is under the 'content' key.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.bell_report(provider='usda', urls=['https://apps.fas.usda.gov/esrqs/ReportsHome.aspx?RN=BR&wed=07%2F03%2F2025&YGO=07%2F04%2F2024&RD=07%2F10%2F2025&MY=N&CID=1%2C&AppUserId=0'])\n# List the reports published for wheat and corn, then download them.\nurls = [d['value'] for d in obb.usda.bell_report_urls(commodity_code='101,401')]\npdfs = obb.usda.bell_report(urls=urls)\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "urls", + "type": "dict[str, list[str]] | list[str] | str | list[dict[str, list[str]] | list[str] | str]", + "description": "Report viewer URLs to download, as returned by the bell_report_urls endpoint. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [], + "usda": [ + { + "name": "error_type", + "type": "str | None", + "description": "Error type, if the report could not be downloaded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "content", + "type": "str", + "description": "Base64-encoded PDF document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "filename", + "type": "str | None", + "description": "The filename of the downloaded PDF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_format", + "type": "dict[str, str] | None", + "description": "Data format information, including data type and filename.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "FasBellReport", + "openapi_extra": { + "widget_config": { + "name": "USDA FAS Bell Report", + "description": "Weekly export sales commitments by commodity and marketing year, published by the Foreign Agricultural Service.", + "type": "multi_file_viewer", + "refetchInterval": false, + "gridData": { + "w": 40, + "h": 30 + }, + "category": "Commodity", + "subCategory": "Agriculture", + "source": [ + "USDA", + "FAS" + ], + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/bell_report_urls", + "optionsParams": { + "commodity_code": "$commodity_code", + "week_ending": "$week_ending" + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "commodity_code", + "label": "Commodity", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/bell_report_commodities", + "optionsParams": { + "is_workspace": true + }, + "value": "101", + "multiSelect": true, + "style": { + "popupWidth": 500 + } + }, + { + "paramName": "week_ending", + "label": "Period Ending Date", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/bell_report_weeks", + "optionsParams": { + "is_workspace": true + }, + "description": "Only published weeks are listed." + } + ] + }, + "model": "FasBellReport" + } + }, + "/usda/publications": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the USDA ERS publications catalog - outlook, research, and discontinued report series.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.publications(provider='usda')\n# Get the Livestock, Dairy, and Poultry Outlook releases.\nobb.usda.publications(series='LDPM', provider='usda')\n# Get every research report released since 2025.\nobb.usda.publications(series='research-reports', start_date='2025-01-01', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "series", + "type": "str | None | list[str | None]", + "description": "Series to retrieve, as a comma-separated list of group names or series codes. Groups expand to their member series. Valid groups are:\n discontinued-reports, outlook-reports, research-reports\nValid series codes are:\n AER (Agricultural Economic Report), AES (Outlook for U.S. Agricultural Trade), AGES (AGES), AH (Agricultural Handbook), AIB (Agricultural Information Bulletin), AIS (Agricultural Income and Finance Outlook), AP (Administrative Publication), AR (Agricultural Resources Situation and Outlook), BIO (Bioenergy), BLA (Bibliographies and Literature of Agriculture), CCR (Contractor and Cooperator Reports), CWS (Cotton and Wool Outlook), EB (Economic Brief), EFAN (Electronic Publications from the Food Assistance & Nutrition Research Program), EIB (Economic Information Bulletin), ERR (Economic Research Report), FANRR (Food Assistance & Nutrition Research Program), FAU (U.S. Agricultural Trade Update), FDS (Feed Outlook), FTS (Fruit and Tree Nuts Outlook), GFA (Food Security Assessment Situation and Outlook), IUS (Industrial Uses of Agricultural Materials Situation and Outlook Report), LDPM (Livestock, Dairy, and Poultry Outlook), MP (Miscellaneous Publication), OCE (USDA Agricultural Projections), OCS (Oil Crops Outlook), RA (Rural America), RCS (Rice Outlook), RDRR (Rural Development Research Report), SB (Statistical Bulletin), SSSM (Sugar and Sweeteners Outlook), TB (Technical Bulletin), TBS (Tobacco Outlook), VGS (Vegetables and Pulses Outlook), WAOB (WAOB), WHS (Wheat Outlook), WRS (International Agriculture and Trade Outlook) Multiple items allowed.", + "default": "outlook-reports", + "optional": true, + "choices": [ + "discontinued-reports", + "outlook-reports", + "research-reports", + "AER", + "AES", + "AGES", + "AH", + "AIB", + "AIS", + "AP", + "AR", + "BIO", + "BLA", + "CCR", + "CWS", + "EB", + "EFAN", + "EIB", + "ERR", + "FANRR", + "FAU", + "FDS", + "FTS", + "GFA", + "IUS", + "LDPM", + "MP", + "OCE", + "OCS", + "RA", + "RCS", + "RDRR", + "SB", + "SSSM", + "TB", + "TBS", + "VGS", + "WAOB", + "WHS", + "WRS" + ], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Earliest release date to return. If None, returns from the first published report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Latest release date to return. If None, returns up to the most recent report.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Maximum number of reports to return, newest first. If None, returns every report in the selected series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ErsPublications", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "id", + "type": "str", + "description": "Publication ID, unique within the ERS publication catalog.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Title of the report, as published.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "release_date", + "type": "date", + "description": "Date the report was released.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "series_code", + "type": "str | None", + "description": "Code of the series the report belongs to, e.g. 'LDPM'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series_name", + "type": "str | None", + "description": "Name of the series the report belongs to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_number", + "type": "str | None", + "description": "Report number within the series, e.g. 'LDP-M-385'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str", + "description": "URL of the publication page. This is the value the report viewer downloads.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "authors", + "type": "str | None", + "description": "Authors of the report, as a comma-separated list.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_description", + "type": "str | None", + "description": "Plain-text summary of the report, when the source publishes one.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "topics", + "type": "str | None", + "description": "Topics the report is filed under, as a comma-separated list.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ErsPublications", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "ErsPublications" + } + }, + "/usda/ers_publication_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the most recent ERS publications as downloadable choices.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "series", + "type": "str", + "description": "", + "default": "outlook-reports", + "optional": true + }, + { + "name": "limit", + "type": "int", + "description": "", + "default": 25, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/ers_publication_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the ERS publication series groups and codes.\n\n Returns\n -------\n list", + "examples": "", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/publication_documents": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download one, or more, USDA ERS publication Full Report PDFs.\n\nThis command returns only the results portion of the OBBject response.\nIt contains a list of dictionaries where the base64 encoded content of the\ndocument is under the 'content' key.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.publication_documents(provider='usda', urls=['https://www.ers.usda.gov/publications/115092'])\n# Download the latest Livestock, Dairy, and Poultry Outlook.\nrows = obb.usda.publications(series='LDPM').to_df()\npdfs = obb.usda.publication_documents(urls=[rows.iloc[0]['url']])\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "urls", + "type": "dict[str, list[str]] | list[str] | str | list[dict[str, list[str]] | list[str] | str]", + "description": "Publication page URLs to download, as returned by the ers_publications endpoint. Each page is resolved to its Full Report PDF. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [], + "usda": [ + { + "name": "error_type", + "type": "str | None", + "description": "Error type, if the report could not be downloaded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "content", + "type": "str", + "description": "Base64-encoded PDF document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "filename", + "type": "str | None", + "description": "The filename of the downloaded PDF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_format", + "type": "dict[str, str] | None", + "description": "Data format information, including data type and filename.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "ErsPublicationDownload", + "openapi_extra": { + "widget_config": { + "name": "USDA ERS Publications Viewer", + "description": "Full Report PDFs published by the USDA Economic Research Service, including the Outlook report series.", + "type": "multi_file_viewer", + "refetchInterval": false, + "gridData": { + "w": 20, + "h": 30 + }, + "category": "Economy", + "subCategory": "Agriculture", + "source": [ + "USDA", + "ERS" + ], + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/ers_publication_urls", + "optionsParams": { + "series": "$series" + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "series", + "label": "Series", + "value": "outlook-reports", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/ers_publication_series", + "style": { + "popupWidth": 500 + } + } + ] + }, + "model": "ErsPublicationDownload" + } + }, + "/usda/psd_report_commodities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the commodities that publish a PSD circular.\n\n Returns\n -------\n list", + "examples": "", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/psd_report_urls": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List PSD circulars for the file selector.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity(ies) to list, as a comma-separated list. When a commodity is given, every historical circular for it is returned, newest first. When None, only the latest circular for every commodity is returned.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/psd_data_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the PSD attributes available for a commodity.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity name. When None (report mode), every attribute is listed.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/psd_data_countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the PSD countries available for a commodity.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity name. When None (report mode), every country and region is listed.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/report_calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the USDA Foreign Agricultural Service calendar of upcoming report releases.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.report_calendar(provider='usda')\n# Get the upcoming Weekly Export Sales releases.\nobb.usda.report_calendar(report_type='export_sales', provider='usda')\n# Get upcoming releases covering cotton.\nobb.usda.report_calendar(commodity='cotton', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "report_type", + "type": "str | None", + "description": "Filter by the type of report.", + "default": null, + "optional": true, + "choices": [ + "export_sales", + "trade_forecast", + "world_markets_trade" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "commodity", + "type": "str | None", + "description": "Filter by commodity.", + "default": null, + "optional": true, + "choices": [ + "beef", + "coffee", + "corn", + "cotton", + "cotton_and_hemp", + "dairy_livestock_and_poultry", + "dairy_products", + "fresh_fruit", + "fruits_and_vegetables", + "grains_feeds_and_fodders", + "oilseeds", + "oilseeds_excluding_soybean", + "pork", + "poultry", + "processed_food_products", + "rice", + "soybeans", + "tree_nuts", + "wheat" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "keyword", + "type": "str | None", + "description": "Free-text filter. Matches a release's associated commodities as well as its title, so it is broader than a title search.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Applied to the release date after fetching.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Applied to the release date after fetching.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FasReportCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "release_date", + "type": "date", + "description": "Date of the release, in Eastern Time.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "release_time", + "type": "str | None", + "description": "Time of day of the release, in Eastern Time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "day_of_week", + "type": "str | None", + "description": "Day of the week of the release.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "release_datetime", + "type": "datetime | None", + "description": "Timestamp of the release, in UTC. None for releases whose scheduled time has already passed, which the source stops publishing a calendar entry for.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "Type of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str", + "description": "Title of the report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "URL of the release announcement.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "released", + "type": "bool", + "description": "Whether the release time has already passed.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "FasReportCalendar", + "openapi_extra": { + "model": "FasReportCalendar" + } + }, + "/usda/dairy_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS dairy data - supply, use, prices, and trade for milk and dairy products.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.dairy_data(provider='usda')\n# Get the dairy situation at a glance since 2020.\nobb.usda.dairy_data(table='situation_at_a_glance', start_year=2020, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None | list[str | None]", + "description": "Table(s) to retrieve, as a comma-separated list of keys. The default, situation_at_a_glance, is a rolling snapshot of the latest ~14 months; the other tables are full histories. Valid tables are:\n cheese_per_capita, fluid_milk_plants, fluid_milk_sales, milk_cows_by_state, milk_fat_skim_solids_allocation, milk_production_quarterly, per_capita_consumption, production_factors, situation_at_a_glance, soft_products_domestic_use, supply_utilization_milk, supply_utilization_products Multiple items allowed.", + "default": "situation_at_a_glance", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Cheese per capita", + "value": "cheese_per_capita" + }, + { + "label": "Fluid milk plants", + "value": "fluid_milk_plants" + }, + { + "label": "Fluid milk sales", + "value": "fluid_milk_sales" + }, + { + "label": "Milk cows by state", + "value": "milk_cows_by_state" + }, + { + "label": "Milk fat skim solids allocation", + "value": "milk_fat_skim_solids_allocation" + }, + { + "label": "Milk production quarterly", + "value": "milk_production_quarterly" + }, + { + "label": "Per capita consumption", + "value": "per_capita_consumption" + }, + { + "label": "Production factors", + "value": "production_factors" + }, + { + "label": "Situation at a glance", + "value": "situation_at_a_glance" + }, + { + "label": "Soft products domestic use", + "value": "soft_products_domestic_use" + }, + { + "label": "Supply utilization milk", + "value": "supply_utilization_milk" + }, + { + "label": "Supply utilization products", + "value": "supply_utilization_products" + } + ], + "style": { + "popupWidth": 340 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Filter rows by observation frequency. Mixed-frequency tables carry annual rows alongside monthly or quarterly rows; annual-only tables carry only 'annual' rows. If None, all frequencies are included.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "options": [ + { + "label": "Monthly", + "value": "monthly" + }, + { + "label": "Quarterly", + "value": "quarterly" + }, + { + "label": "Annual", + "value": "annual" + } + ] + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the beginning of each series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DairyData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "category", + "type": "str | None", + "description": "Category grouping of the data item, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Category", + "pinned": "left" + } + } + }, + { + "name": "data_item", + "type": "str", + "description": "Data item name, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Data item", + "pinned": "left" + } + } + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the value, as published; casing varies by table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit" + } + } + }, + { + "name": "sub_table", + "type": "str | None", + "description": "Published sub-table name within the dataset, e.g. 'Butter, monthly', 'M.E. Milk-fat basis, annual', or 'Milk cows'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Sub-table", + "hide": true + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "Dairy product category. Only present for supply_utilization_products.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Product", + "hide": true + } + } + }, + { + "name": "data_item_id", + "type": "str | None", + "description": "Hierarchical data item code, e.g. '1-3.04.00'; the same suffix identifies the same product across tables. Only present for milk_fat_skim_solids_allocation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Item ID", + "hide": true + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "ERS farm production region. Only present for milk_cows_by_state.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Region", + "hide": true + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State name; regional and national aggregates use 'Total region'. Only present for milk_cows_by_state.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "hide": true + } + } + } + ] + }, + "model": "DairyData", + "openapi_extra": { + "model": "DairyData" + } + }, + "/usda/milk_cost_of_production": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS milk cost of production estimates, by state or by size of operation.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.milk_cost_of_production(provider='usda')\n# Get milk production costs by size of operation.\nobb.usda.milk_cost_of_production(report='by_size_of_operation', provider='usda')\n# Get Wisconsin operating costs since 2022.\nobb.usda.milk_cost_of_production(state='wisconsin', category='operating costs', start_year=2022, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "report", + "type": "str | None", + "description": "Report to retrieve: estimates by state or by size of operation (herd-size class).", + "default": "by_state", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Report", + "options": [ + { + "label": "By state", + "value": "by_state" + }, + { + "label": "By herd-size class", + "value": "by_size_of_operation" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State(s) to filter, as a comma-separated list. Only valid with report='by_state'. If None, all states and the U.S. total are returned. Valid states are:\n california, indiana, iowa, kentucky, michigan, minnesota, new_york, ohio, pennsylvania, us_total, wisconsin Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "multiSelect": false, + "multiple": false, + "value": "us_total", + "options": [ + { + "label": "U.S. total", + "value": "us_total" + }, + { + "label": "California", + "value": "california" + }, + { + "label": "Indiana", + "value": "indiana" + }, + { + "label": "Iowa", + "value": "iowa" + }, + { + "label": "Kentucky", + "value": "kentucky" + }, + { + "label": "Michigan", + "value": "michigan" + }, + { + "label": "Minnesota", + "value": "minnesota" + }, + { + "label": "New York", + "value": "new_york" + }, + { + "label": "Ohio", + "value": "ohio" + }, + { + "label": "Pennsylvania", + "value": "pennsylvania" + }, + { + "label": "Wisconsin", + "value": "wisconsin" + } + ] + } + } + }, + { + "name": "size", + "type": "str | None | list[str | None]", + "description": "Herd-size class(es) to filter, as a comma-separated list. Only valid with report='by_size_of_operation'. If None, all size classes are returned. Valid sizes are:\n 1000_1999_cows, 100_199_cows, 2000_cows_or_more, 200_499_cows, 500_999_cows, 50_99_cows, all_sizes, fewer_than_50_cows Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Herd-size class", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Fewer than 50 cows", + "value": "fewer_than_50_cows" + }, + { + "label": "50\u201399 cows", + "value": "50_99_cows" + }, + { + "label": "100\u2013199 cows", + "value": "100_199_cows" + }, + { + "label": "200\u2013499 cows", + "value": "200_499_cows" + }, + { + "label": "500\u2013999 cows", + "value": "500_999_cows" + }, + { + "label": "1,000\u20131,999 cows", + "value": "1000_1999_cows" + }, + { + "label": "2,000 cows or more", + "value": "2000_cows_or_more" + }, + { + "label": "All sizes", + "value": "all_sizes" + } + ] + } + } + }, + { + "name": "category", + "type": "str | None | list[str | None]", + "description": "Estimate category(s) to filter, as a comma-separated list. If None, all categories are returned. Valid categories are:\n allocated_overhead, costs_listed, gross_value_of_production, net_value, operating_costs, supporting_information Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Cost category", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Gross value of production", + "value": "gross_value_of_production" + }, + { + "label": "Operating costs", + "value": "operating_costs" + }, + { + "label": "Allocated overhead", + "value": "allocated_overhead" + }, + { + "label": "Costs listed", + "value": "costs_listed" + }, + { + "label": "Net value", + "value": "net_value" + }, + { + "label": "Supporting information", + "value": "supporting_information" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "item", + "type": "str | None | list[str | None]", + "description": "Estimate item(s) to filter, as a comma-separated list. If None, all items are returned. Valid items are:\n bedding_and_litter, capital_recovery_of_machinery_and_equipment, cattle, custom_services, fuel_lube_and_electricity, general_farm_overhead, grazed_feed, hired_labor, homegrown_harvested_feed, interest_on_operating_capital, marketing, milk_cows, milk_sold, opportunity_cost_of_land, opportunity_cost_of_unpaid_labor, other_income, other_operating_costs, output_per_cow, purchased_feed, repairs, taxes_and_insurance, total_allocated_overhead, total_costs_listed, total_feed_costs, total_gross_value_of_production, total_operating_costs, value_of_production_less_operating_costs, value_of_production_less_total_costs_listed, veterinary_and_medicine Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Cost item", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/milk_cost_items", + "optionsParams": { + "report": "$report", + "category": "$category" + }, + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "MilkCostOfProduction", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "group", + "type": "str", + "description": "Population the estimate covers: the State, or 'U.S. total' for the national aggregate, in the by_state report; the herd-size class in the by_size_of_operation report.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State / herd size", + "pinned": "left" + } + } + }, + { + "name": "category", + "type": "str", + "description": "Estimate category, as published. One of: Gross value of production, Operating costs, Allocated overhead, Costs listed, Net value, Supporting information.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cost category", + "pinned": "left" + } + } + }, + { + "name": "item", + "type": "str", + "description": "Estimate item, as published, with footnote superscripts stripped. Includes published subtotal and net-value rows.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cost item", + "pinned": "left" + } + } + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the value, as published. Cost and return items are 'dollars per hundredweight sold'; 'Milk cows' is 'head per farm' and 'Output per cow' is 'pounds'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit" + } + } + } + ] + }, + "model": "MilkCostOfProduction", + "openapi_extra": { + "model": "MilkCostOfProduction" + } + }, + "/usda/major_land_uses": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS major land uses - acreage by land use class for the United States and its regions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.major_land_uses(provider='usda')\n# Get cropland used for crops.\nobb.usda.major_land_uses(table='cropland_used_for_crops', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Dataset to retrieve. 'land_use' is land by major use, region, and State for Census of Agriculture benchmark years 1945-2017. 'cropland_used_for_crops' is the national annual cropland-used-for-crops series, 1910 to the current year.", + "default": "land_use", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "options": [ + { + "label": "Land use by region & State", + "value": "land_use" + }, + { + "label": "Cropland used for crops (annual)", + "value": "cropland_used_for_crops" + } + ] + } + } + }, + { + "name": "land_use", + "type": "str | None | list[str | None]", + "description": "Land use category(ies) to retrieve, as a comma-separated list. Only applies when table='land_use'; if None, all categories are returned. Valid categories are:\n cropland_idled, cropland_used_for_crops, cropland_used_for_pasture, defense_and_industrial, farmsteads_roads_and_miscellaneous_farmland, forest_use_land, grassland_pasture_and_range, grazed_forest_use_land, miscellaneous_other_land, rural_parks_and_wildlife, rural_transportation, special_uses, total_cropland, total_land, ungrazed_forest_use_land, urban_areas Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Land use", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Cropland idled", + "value": "cropland_idled" + }, + { + "label": "Cropland used for crops", + "value": "cropland_used_for_crops" + }, + { + "label": "Cropland used for pasture", + "value": "cropland_used_for_pasture" + }, + { + "label": "Defense and industrial", + "value": "defense_and_industrial" + }, + { + "label": "Farmsteads roads and miscellaneous farmland", + "value": "farmsteads_roads_and_miscellaneous_farmland" + }, + { + "label": "Forest use land", + "value": "forest_use_land" + }, + { + "label": "Grassland pasture and range", + "value": "grassland_pasture_and_range" + }, + { + "label": "Grazed forest use land", + "value": "grazed_forest_use_land" + }, + { + "label": "Miscellaneous other land", + "value": "miscellaneous_other_land" + }, + { + "label": "Rural parks and wildlife", + "value": "rural_parks_and_wildlife" + }, + { + "label": "Rural transportation", + "value": "rural_transportation" + }, + { + "label": "Special uses", + "value": "special_uses" + }, + { + "label": "Total cropland", + "value": "total_cropland" + }, + { + "label": "Total land", + "value": "total_land" + }, + { + "label": "Ungrazed forest use land", + "value": "ungrazed_forest_use_land" + }, + { + "label": "Urban areas", + "value": "urban_areas" + } + ], + "style": { + "popupWidth": 340 + } + } + } + }, + { + "name": "geography", + "type": "str | None | list[str | None]", + "description": "Geography(ies) to retrieve, as a comma-separated list of State names, farm production region names, '48 States', or 'U.S. total'. Only applies when table='land_use'; if None, all geographies are returned. Valid geographies are:\n 48 States, Alabama, Alaska, Appalachian, Arizona, Arkansas, California, Colorado, Connecticut, Corn Belt, Delaware, Delta States, District of Columbia, Florida, Georgia, Hawaii, Idaho, Illinois, Indiana, Iowa, Kansas, Kentucky, Lake States, Louisiana, Maine, Maryland, Massachusetts, Michigan, Minnesota, Mississippi, Missouri, Montana, Mountain, Nebraska, Nevada, New Hampshire, New Jersey, New Mexico, New York, North Carolina, North Dakota, Northeast, Northern Plains, Ohio, Oklahoma, Oregon, Pacific, Pennsylvania, Rhode Island, South Carolina, South Dakota, Southeast, Southern Plains, Tennessee, Texas, U.S. total, Utah, Vermont, Virginia, Washington, West Virginia, Wisconsin, Wyoming Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "Geography", + "multiSelect": false, + "multiple": false, + "value": "48 States", + "options": [ + { + "label": "48 States", + "value": "48 States" + }, + { + "label": "Alabama", + "value": "Alabama" + }, + { + "label": "Alaska", + "value": "Alaska" + }, + { + "label": "Appalachian", + "value": "Appalachian" + }, + { + "label": "Arizona", + "value": "Arizona" + }, + { + "label": "Arkansas", + "value": "Arkansas" + }, + { + "label": "California", + "value": "California" + }, + { + "label": "Colorado", + "value": "Colorado" + }, + { + "label": "Connecticut", + "value": "Connecticut" + }, + { + "label": "Corn Belt", + "value": "Corn Belt" + }, + { + "label": "Delaware", + "value": "Delaware" + }, + { + "label": "Delta States", + "value": "Delta States" + }, + { + "label": "District of Columbia", + "value": "District of Columbia" + }, + { + "label": "Florida", + "value": "Florida" + }, + { + "label": "Georgia", + "value": "Georgia" + }, + { + "label": "Hawaii", + "value": "Hawaii" + }, + { + "label": "Idaho", + "value": "Idaho" + }, + { + "label": "Illinois", + "value": "Illinois" + }, + { + "label": "Indiana", + "value": "Indiana" + }, + { + "label": "Iowa", + "value": "Iowa" + }, + { + "label": "Kansas", + "value": "Kansas" + }, + { + "label": "Kentucky", + "value": "Kentucky" + }, + { + "label": "Lake States", + "value": "Lake States" + }, + { + "label": "Louisiana", + "value": "Louisiana" + }, + { + "label": "Maine", + "value": "Maine" + }, + { + "label": "Maryland", + "value": "Maryland" + }, + { + "label": "Massachusetts", + "value": "Massachusetts" + }, + { + "label": "Michigan", + "value": "Michigan" + }, + { + "label": "Minnesota", + "value": "Minnesota" + }, + { + "label": "Mississippi", + "value": "Mississippi" + }, + { + "label": "Missouri", + "value": "Missouri" + }, + { + "label": "Montana", + "value": "Montana" + }, + { + "label": "Mountain", + "value": "Mountain" + }, + { + "label": "Nebraska", + "value": "Nebraska" + }, + { + "label": "Nevada", + "value": "Nevada" + }, + { + "label": "New Hampshire", + "value": "New Hampshire" + }, + { + "label": "New Jersey", + "value": "New Jersey" + }, + { + "label": "New Mexico", + "value": "New Mexico" + }, + { + "label": "New York", + "value": "New York" + }, + { + "label": "North Carolina", + "value": "North Carolina" + }, + { + "label": "North Dakota", + "value": "North Dakota" + }, + { + "label": "Northeast", + "value": "Northeast" + }, + { + "label": "Northern Plains", + "value": "Northern Plains" + }, + { + "label": "Ohio", + "value": "Ohio" + }, + { + "label": "Oklahoma", + "value": "Oklahoma" + }, + { + "label": "Oregon", + "value": "Oregon" + }, + { + "label": "Pacific", + "value": "Pacific" + }, + { + "label": "Pennsylvania", + "value": "Pennsylvania" + }, + { + "label": "Rhode Island", + "value": "Rhode Island" + }, + { + "label": "South Carolina", + "value": "South Carolina" + }, + { + "label": "South Dakota", + "value": "South Dakota" + }, + { + "label": "Southeast", + "value": "Southeast" + }, + { + "label": "Southern Plains", + "value": "Southern Plains" + }, + { + "label": "Tennessee", + "value": "Tennessee" + }, + { + "label": "Texas", + "value": "Texas" + }, + { + "label": "U.S. total", + "value": "U.S. total" + }, + { + "label": "Utah", + "value": "Utah" + }, + { + "label": "Vermont", + "value": "Vermont" + }, + { + "label": "Virginia", + "value": "Virginia" + }, + { + "label": "Washington", + "value": "Washington" + }, + { + "label": "West Virginia", + "value": "West Virginia" + }, + { + "label": "Wisconsin", + "value": "Wisconsin" + }, + { + "label": "Wyoming", + "value": "Wyoming" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. None returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "MajorLandUses", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "geography", + "type": "str", + "description": "Geography of the observation: a State name, a farm production region name, '48 States', or 'U.S. total' for the land_use table; 'United States' for the annual table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Geography", + "pinned": "left" + } + } + }, + { + "name": "land_use", + "type": "str", + "description": "Land use category of the observation. For the land_use table, one of the 16 category slugs; for the annual table, one of: total_crops_harvested, double_cropped, cropland_harvested, crop_failure, cultivated_summer_fallow, total_cropland_used_for_crops.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Land use", + "pinned": "left" + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "Farm production region the State belongs to. None for regional and national aggregate rows.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Region", + "hide": true + } + } + } + ] + }, + "model": "MajorLandUses", + "openapi_extra": { + "model": "MajorLandUses" + } + }, + "/usda/agricultural_trade": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the ERS U.S. agricultural trade data update - each table pivoted to a wide layout with the year and period in the rows and the trade direction, commodity, or trade partner spread into columns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.agricultural_trade(provider='usda')\n# Get the top export markets for corn, by volume.\nobb.usda.agricultural_trade(table='top_export_markets', commodity='Corn', provider='usda')\n# Get the monthly agricultural trade totals since 2020.\nobb.usda.agricultural_trade(table='monthly', start_year=2020, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve, pivoted to a wide layout. The natural 'many' dimension spreads into columns (trade direction for the summary and monthly tables, commodity for the year-to-date export and import tables, trade partner for the top-market tables) while a single pinned period column labels the rows. Valid tables are:\n summary, monthly, exports_ytd, imports_ytd, top_export_markets, top_import_sources", + "default": "exports_ytd", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "exports_ytd", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Summary", + "value": "summary" + }, + { + "label": "Monthly total", + "value": "monthly" + }, + { + "label": "Exports, year-to-date", + "value": "exports_ytd" + }, + { + "label": "Imports, year-to-date", + "value": "imports_ytd" + }, + { + "label": "Top export markets", + "value": "top_export_markets" + }, + { + "label": "Top import sources", + "value": "top_import_sources" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "period_basis", + "type": "str | None", + "description": "Reporting basis to keep, one of those the selected table publishes: 'Fiscal year', 'Calendar year', 'Fiscal year-to-date', 'Calendar year-to-date', or 'Monthly'. Filtering to one basis yields a single aligned time series instead of mixing annual totals, year-to-date spans, and single months. If None, the table's default basis is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Period basis", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/agricultural_trade_periods", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "value_type", + "type": "str | None", + "description": "Measure to spread into the wide cells, scoped to the table: 'value' (customs value), 'volume', or 'cif' (cost, insurance, and freight). If None or invalid for the table, the table's first measure is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "type": "endpoint", + "value": "value", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/agricultural_trade_measures", + "optionsParams": { + "table": "$table" + } + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity whose trade partners spread into columns, for the top-export-market and top-import-source tables only, as a single exact name as published, e.g. 'Soybeans'. If None, the table's first commodity is used. Ignored by the summary, monthly, and year-to-date tables.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity (partner tables)", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/agricultural_trade_commodities", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. None returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + }, + { + "name": "latest", + "type": "bool | None", + "description": "Return only the most recent monthly update vintage for tables that retain the marketing year's prior vintages. No effect on the summary and monthly tables.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Latest vintage only" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsAgriculturalTrade", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year with the published time span appended, e.g. '2026 May', '2026 October-May', or '2024 Fiscal year, October-September'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 240 + } + } + } + ] + }, + "model": "UsAgriculturalTrade", + "openapi_extra": { + "model": "UsAgriculturalTrade" + } + }, + "/usda/agricultural_trade_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the measures available in an agricultural-trade table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table slug to scope the measures to. When None or unknown, the year-to-date exports table's measures are returned.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/agricultural_trade_commodities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the commodities available in an agricultural-trade table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table slug to scope the commodities to. When None, every commodity is returned.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/agricultural_trade_periods": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the reporting bases an agricultural-trade table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table slug to scope the bases to. When unknown, the year-to-date exports table is used.", + "default": "exports_ytd", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/meat_price_spreads": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS meat price spreads - retail values, farm values, price spreads, and farmers' shares for beef, pork, poultry, and eggs.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.meat_price_spreads(provider='usda')\n# Get the pork values and spreads table, annual rows only.\nobb.usda.meat_price_spreads(table='pork', frequency='annual', provider='usda')\n# Get the historical monthly beef, pork, and broiler series since 2000.\nobb.usda.meat_price_spreads(table='historical_monthly', start_year=2000, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. Each table is a self-contained set of data items pivoted into columns; the column set differs by table. Valid tables are:\n summary, choice_beef, pork, retail_prices, historical_monthly", + "default": "choice_beef", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "multiSelect": false, + "multiple": false, + "value": "choice_beef", + "options": [ + { + "label": "Summary of retail prices and price spreads", + "value": "summary" + }, + { + "label": "Choice beef values and spreads and the all-fresh retail value", + "value": "choice_beef" + }, + { + "label": "Pork values and spreads", + "value": "pork" + }, + { + "label": "Retail prices for beef, pork, poultry cuts, eggs, and dairy products", + "value": "retail_prices" + }, + { + "label": "Historical monthly price spread data for beef, pork, broilers", + "value": "historical_monthly" + } + ], + "style": { + "popupWidth": 480 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Filter rows by observation frequency. Only the choice_beef and pork tables mix annual, quarterly, and monthly rows; the other tables carry only monthly rows. If None, all frequencies are included.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Quarterly", + "value": "quarterly" + }, + { + "label": "Monthly", + "value": "monthly" + } + ] + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. None returns from the beginning of the series (historical_monthly reaches 1970).", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "MeatPriceSpreads", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual rows ('2020'), the year and the within-year period for sub-annual rows ('2020 January', '2020 Quarter 1, January-March'). The table's published data items spread into the wide value columns.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 240 + } + } + } + ] + }, + "model": "MeatPriceSpreads", + "openapi_extra": { + "model": "MeatPriceSpreads" + } + }, + "/usda/wheat_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS wheat data - the Wheat Yearbook supply, use, price, and trade tables, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.wheat_data(provider='usda')\n# Get world and U.S. wheat supply and disappearance since 2010.\nobb.usda.wheat_data(table='world_supply_and_disappearance', start_year=2010, provider='usda')\n# Get the historical by-class quarterly balance sheet.\nobb.usda.wheat_data(table='by_class_quarterly', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Wheat-data table to retrieve. Each table is a set of named balance-sheet, price, or trade series indexed by year and period; the series become the wide value columns while any varying wheat class, destination, market, product, or unit is folded into the pinned period label. Valid tables are:\n wheat_acreage_production_yield_price, rye_acreage_production_yield_price, world_supply_and_disappearance, us_supply_and_disappearance, rye_supply_and_disappearance, food_use, government_and_private_stocks, domestic_and_international_prices, export_import_trade_by_component, all_wheat_destination_exports, by_class_inspections, exports_by_government_program, flour_production_and_disappearance, wheat_flour_price_relationships, by_class_trade_data, by_class_quarterly", + "default": "us_supply_and_disappearance", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "us_supply_and_disappearance", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "U.S. wheat: acreage, production, yield, and farm price", + "value": "wheat_acreage_production_yield_price" + }, + { + "label": "U.S. rye: acreage, production, yield, and farm price", + "value": "rye_acreage_production_yield_price" + }, + { + "label": "World and U.S. wheat supply and disappearance", + "value": "world_supply_and_disappearance" + }, + { + "label": "U.S. wheat supply and disappearance, by class", + "value": "us_supply_and_disappearance" + }, + { + "label": "U.S. rye supply and disappearance", + "value": "rye_supply_and_disappearance" + }, + { + "label": "U.S. wheat food use", + "value": "food_use" + }, + { + "label": "Government and private wheat stocks", + "value": "government_and_private_stocks" + }, + { + "label": "Domestic and international wheat prices", + "value": "domestic_and_international_prices" + }, + { + "label": "Wheat export and import trade, by component", + "value": "export_import_trade_by_component" + }, + { + "label": "All-wheat exports, by destination", + "value": "all_wheat_destination_exports" + }, + { + "label": "Wheat inspections, by class and destination", + "value": "by_class_inspections" + }, + { + "label": "Wheat exports, by government program", + "value": "exports_by_government_program" + }, + { + "label": "Wheat flour production and disappearance", + "value": "flour_production_and_disappearance" + }, + { + "label": "Wheat and flour price relationships", + "value": "wheat_flour_price_relationships" + }, + { + "label": "Wheat trade, by class", + "value": "by_class_trade_data" + }, + { + "label": "By-class quarterly balance sheet", + "value": "by_class_quarterly" + } + ], + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the first four digits of the marketing, calendar, or fiscal year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the first four digits of the marketing, calendar, or fiscal year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "WheatData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the marketing, calendar, or fiscal year and its within-year period ('2024/25 MY Jun-May', '1989/90 Apr'), with any varying wheat class, destination, market, product, or unit prefixed so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 300 + } + } + } + ] + }, + "model": "WheatData", + "openapi_extra": { + "model": "WheatData" + } + }, + "/usda/commodity_costs_and_returns": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS commodity costs and returns - annual per-unit cost-and-return budgets by commodity and ERS Farm Resource Region.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.commodity_costs_and_returns(provider='usda')\n# Get the U.S. total corn budget since 2020.\nobb.usda.commodity_costs_and_returns(commodity='corn', region='U.S. total', start_year=2020, provider='usda')\n# Get farrow-to-finish hog operating costs.\nobb.usda.commodity_costs_and_returns(commodity='hogs_farrow_finish', category='operating_costs', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "commodity", + "type": "str | None", + "description": "Commodity budget to retrieve; selects the per-commodity cost-and-return file. Valid commodities are:\n corn, cotton, barley, peanuts, rice, sorghum, oats, soybeans, wheat, milk, cow_calf, hogs_all, hogs_farrow_finish, hogs_farrow_feeder, hogs_feeder_finish, hogs_farrow_weanling, hogs_weanling_feeder", + "default": "corn", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity", + "multiSelect": false, + "multiple": false, + "value": "corn", + "options": [ + { + "label": "Corn", + "value": "corn" + }, + { + "label": "Cotton", + "value": "cotton" + }, + { + "label": "Barley", + "value": "barley" + }, + { + "label": "Peanuts", + "value": "peanuts" + }, + { + "label": "Rice", + "value": "rice" + }, + { + "label": "Sorghum", + "value": "sorghum" + }, + { + "label": "Oats", + "value": "oats" + }, + { + "label": "Soybeans", + "value": "soybeans" + }, + { + "label": "Wheat", + "value": "wheat" + }, + { + "label": "Milk", + "value": "milk" + }, + { + "label": "Cow-calf", + "value": "cow_calf" + }, + { + "label": "Hogs (all enterprises)", + "value": "hogs_all" + }, + { + "label": "Hogs, farrow-to-finish", + "value": "hogs_farrow_finish" + }, + { + "label": "Hogs, farrow-to-feeder", + "value": "hogs_farrow_feeder" + }, + { + "label": "Hogs, feeder-to-finish", + "value": "hogs_feeder_finish" + }, + { + "label": "Hogs, farrow-to-weanling", + "value": "hogs_farrow_weanling" + }, + { + "label": "Hogs, weanling-to-feeder", + "value": "hogs_weanling_feeder" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "ERS Farm Resource Region to retrieve, as the published region label. The region set varies per commodity. If None, every region in the commodity's budget is returned, with 'U.S. total' the national aggregate.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Region", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": "U.S. total", + "optionsEndpoint": "/api/v1/usda/commodity_cost_regions", + "optionsParams": { + "commodity": "$commodity" + }, + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "category", + "type": "str | None", + "description": "Budget section to retrieve. If None, all sections are returned. Valid sections are:\n gross_value_of_production, operating_costs, net_value, allocated_overhead, costs_listed, supporting_information, production_practices, size_of_operation, production_arrangement", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Budget section", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Gross value of production", + "value": "gross_value_of_production" + }, + { + "label": "Operating costs", + "value": "operating_costs" + }, + { + "label": "Net value", + "value": "net_value" + }, + { + "label": "Allocated overhead", + "value": "allocated_overhead" + }, + { + "label": "Costs listed", + "value": "costs_listed" + }, + { + "label": "Supporting information", + "value": "supporting_information" + }, + { + "label": "Production practices", + "value": "production_practices" + }, + { + "label": "Size of operation", + "value": "size_of_operation" + }, + { + "label": "Production arrangement", + "value": "production_arrangement" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. None returns from the commodity's first available year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CommodityCostsAndReturns", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity name, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "hide": true + } + } + }, + { + "name": "region", + "type": "str", + "description": "ERS Farm Resource Region of the budget, or 'U.S. total' for the national aggregate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Region", + "pinned": "left" + } + } + }, + { + "name": "category", + "type": "str", + "description": "Budget section of the line, as published, e.g. 'Operating costs' or 'Gross value of production'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Budget section", + "pinned": "left" + } + } + }, + { + "name": "item", + "type": "str", + "description": "Budget line item, as published, with footnote superscripts and stray whitespace stripped.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Item", + "pinned": "left" + } + } + }, + { + "name": "units", + "type": "str", + "description": "Unit of the line's values, as published, e.g. 'dollars per planted acre' or 'bushels per planted acre'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Units" + } + } + }, + { + "name": "survey_base_year", + "type": "str | None", + "description": "Survey base of the most recent year in the row, as published, e.g. 'Base survey of 2021'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Survey base", + "hide": true + } + } + } + ] + }, + "model": "CommodityCostsAndReturns", + "openapi_extra": { + "model": "CommodityCostsAndReturns" + } + }, + "/usda/commodity_cost_regions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the ERS Farm Resource Regions for a commodity's cost budget.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity key. Unknown commodities fall back to corn's regions.", + "default": "corn", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/rice_frequencies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the observation frequencies a Rice Yearbook table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key from RICE_TABLES. When absent, the default table is used.", + "default": "us_supply_disappearance_price", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/rice_yearbook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS rice data - the Rice Yearbook acreage, supply, use, stocks, price, and trade tables, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.rice_yearbook(provider='usda')\n# Get world rice trade on a milled basis since 2020.\nobb.usda.rice_yearbook(table='world_trade_milled_basis', start_year=2020, provider='usda')\n# Get the top 10 U.S. rice export markets.\nobb.usda.rice_yearbook(table='us_top_export_markets', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Rice-yearbook table to retrieve. Each table is a set of named acreage, supply-use, price, or trade series indexed by year and period; the series become the wide value columns while time stays in the rows. Valid tables are:\n us_area_planted_by_class, us_state_yields, us_acreage_yield_production, us_production_by_class, us_state_acreage_yield_production_by_class, us_production_class_distribution, us_supply_use_by_class, us_supply_disappearance_price, long_grain_supply_disappearance_price, medium_short_grain_supply_disappearance_price, us_stocks_rough_and_milled, us_exports_by_type, us_top_export_markets, us_imports_by_origin, us_rough_price_by_month, us_rough_price_by_month_and_class, us_milled_price_milling_centers, us_byproduct_prices, us_brewers_rice_prices, us_prices_and_payment_rates, us_class_loan_values, world_market_prices_loan_basis, world_supply_and_utilization, world_trade_milled_basis, thailand_export_prices, vietnam_export_prices, india_export_prices, pakistan_export_prices", + "default": "us_supply_disappearance_price", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "us_supply_disappearance_price", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "U.S. rice area planted, by class and State", + "value": "us_area_planted_by_class" + }, + { + "label": "U.S. rice yield, by State", + "value": "us_state_yields" + }, + { + "label": "U.S. rice acreage, yield, and production", + "value": "us_acreage_yield_production" + }, + { + "label": "U.S. rice production, by class and State", + "value": "us_production_by_class" + }, + { + "label": "U.S. rice acreage, yield, and production, by class and State", + "value": "us_state_acreage_yield_production_by_class" + }, + { + "label": "U.S. rice production and class distribution", + "value": "us_production_class_distribution" + }, + { + "label": "U.S. rice supply and use, by class and region", + "value": "us_supply_use_by_class" + }, + { + "label": "U.S. rice supply, disappearance, and price", + "value": "us_supply_disappearance_price" + }, + { + "label": "U.S. long-grain rice supply, disappearance, and price", + "value": "long_grain_supply_disappearance_price" + }, + { + "label": "U.S. medium- and short-grain rice supply, disappearance, and price", + "value": "medium_short_grain_supply_disappearance_price" + }, + { + "label": "U.S. rice stocks, rough and milled", + "value": "us_stocks_rough_and_milled" + }, + { + "label": "U.S. rice exports, by type", + "value": "us_exports_by_type" + }, + { + "label": "Top 10 U.S. rice export markets", + "value": "us_top_export_markets" + }, + { + "label": "U.S. rice imports, by origin", + "value": "us_imports_by_origin" + }, + { + "label": "U.S. rough rice prices received, by month and State", + "value": "us_rough_price_by_month" + }, + { + "label": "U.S. rough rice prices received, by month and class", + "value": "us_rough_price_by_month_and_class" + }, + { + "label": "U.S. milled rice prices at milling centers", + "value": "us_milled_price_milling_centers" + }, + { + "label": "U.S. rice byproduct prices", + "value": "us_byproduct_prices" + }, + { + "label": "U.S. brewers' rice prices", + "value": "us_brewers_rice_prices" + }, + { + "label": "U.S. rice prices and program payment rates", + "value": "us_prices_and_payment_rates" + }, + { + "label": "U.S. rice loan rates, by class", + "value": "us_class_loan_values" + }, + { + "label": "World rice market prices, loan basis", + "value": "world_market_prices_loan_basis" + }, + { + "label": "World rice supply and utilization", + "value": "world_supply_and_utilization" + }, + { + "label": "World rice trade, milled basis", + "value": "world_trade_milled_basis" + }, + { + "label": "Thailand rice export prices", + "value": "thailand_export_prices" + }, + { + "label": "Vietnam rice export prices", + "value": "vietnam_export_prices" + }, + { + "label": "India rice export prices", + "value": "india_export_prices" + }, + { + "label": "Pakistan rice export prices", + "value": "pakistan_export_prices" + } + ], + "style": { + "popupWidth": 460 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Observation frequency to keep, one of the frequencies the selected table publishes: 'Annual', 'Point-in-time', 'Weekly', or 'Monthly'. Filtering to one frequency yields a single aligned time series. If None, the finest frequency the table offers is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/rice_frequencies", + "optionsParams": { + "table": "$table" + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "RiceYearbook", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual tables ('2020'), the year and month or stocks date for sub-annual tables ('2020 August', '2020 March 1'), with any varying class, location, or rank dimension prefixed so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 320 + } + } + } + ] + }, + "model": "RiceYearbook", + "openapi_extra": { + "model": "RiceYearbook" + } + }, + "/usda/sugar_frequencies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the period bases a Sugar and Sweeteners Yearbook table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key from SUGAR_SWEETENERS_FILES. When absent, the default table is used.", + "default": "table_24a", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/sugar_sweeteners_yearbook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Sugar and Sweeteners Yearbook tables - U.S., Mexican, and world sugar and sweetener prices, supply and use, production, consumption, and trade, each pivoted to a wide layout by attribute.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.sugar_sweeteners_yearbook(provider='usda')\n# Get U.S. sugar supply and use since 2020.\nobb.usda.sugar_sweeteners_yearbook(table='table_24a', start_year=2020, provider='usda')\n# Get the world white refined sugar futures price table.\nobb.usda.sugar_sweeteners_yearbook(table='table_2', provider='usda')\n# Get U.S. honey imports by country of source since 2020.\nobb.usda.sugar_sweeteners_yearbook(table='table_48a', start_year=2020, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Sugar and Sweeteners Yearbook table to retrieve. Each table is a set of named price, supply-and-use, production, or trade series indexed by year and period; the attributes become the wide value columns while time stays in the rows. Valid tables are:\n table_2, table_3a, table_3b, table_4, table_5, table_5a, table_6, table_7, table_8, table_9, table_10, table_11, table_12, table_13, table_31a, table_31b, table_54, table_55, table_14, table_15, table_16, table_17, table_18, table_19, table_20a, table_20b, table_21, table_22, table_46, table_47, table_48a, table_48b, table_49, table_50, table_51, table_52, table_53, table_24a, table_24b, table_25, table_26, table_56a, table_56b, table_27, table_28, table_29, table_30, table_34a, table_34b, table_35a, table_35b, table_36, table_37, table_38, table_57, table_58a, table_58b, table_58c, table_59a, table_59b, table_60a, table_60b, table_60c, table_60d, table_60e, table_61a, table_61b", + "default": "table_24a", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "table_24a", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 2: World white (refined) sugar nearby futures price, ICE Contract Number 5, monthly, quarterly, and by calendar and fiscal year, since 1980, cents per pound", + "value": "table_2" + }, + { + "label": "Table 3a: World raw sugar price, monthly, quarterly, and by calendar and fiscal year, 1960 to 2011, cents per pound, discontinued as of July 1, 2011", + "value": "table_3a" + }, + { + "label": "Table 3b: World raw sugar nearby futures price, ICE Contract Number 11, monthly, quarterly, and by calendar and fiscal year, since 1989, cents per pound", + "value": "table_3b" + }, + { + "label": "Table 4: U.S. raw sugar nearby futures price, ICE Contract Number 16, monthly, quarterly, and by calendar and fiscal year, since 1960, cents per pound", + "value": "table_4" + }, + { + "label": "Table 5: U.S. spot price for bulk refined beet sugar, Midwest markets, monthly, quarterly, and by calendar and fiscal year, since 1960, cents per pound", + "value": "table_5" + }, + { + "label": "Table 5a: U.S. calendar price for bulk refined cane sugar, Northeast markets, monthly, quarterly, and by calendar and fiscal year, since 1999, cents per pound", + "value": "table_5a" + }, + { + "label": "Table 6: U.S. retail refined sugar price, monthly, quarterly, and by calendar and fiscal year, since 1960, cents per pound", + "value": "table_6" + }, + { + "label": "Table 7: U.S. spot price for bulk glucose syrup, Midwest markets, monthly, quarterly, and by calendar and fiscal year, since 1975, cents per pound (dry weight)", + "value": "table_7" + }, + { + "label": "Table 8: U.S. spot price for bulk dextrose, Midwest markets, monthly, quarterly, and by calendar and fiscal year, since 1975, cents per pound (dry weight)", + "value": "table_8" + }, + { + "label": "Table 9: U.S. price for bulk high-fructose corn syrup, Midwest markets, monthly, quarterly, and by calendar and fiscal year, since 1994, cents per pound (dry weight)", + "value": "table_9" + }, + { + "label": "Table 10: U.S. producer price index for corn sweeteners and sugar, monthly, not seasonally adjusted, since 1967", + "value": "table_10" + }, + { + "label": "Table 11: U.S. consumer price index for sugar and selected sweetener-containing products, monthly and by calendar year, in U.S. city average, all urban consumers, not seasonally adjusted, since 1978", + "value": "table_11" + }, + { + "label": "Table 12: Sugarbeet price per ton, by State and United States, since 1972/73, dollars per ton", + "value": "table_12" + }, + { + "label": "Table 13: Sugarcane for sugar: price per ton, by State, since 1972/73, dollars per ton", + "value": "table_13" + }, + { + "label": "Table 31a: Net cost of corn starch to U.S. wet-millers, Midwest markets, quarterly, since 1990", + "value": "table_31a" + }, + { + "label": "Table 31b: Net cost of corn starch to U.S. wet-millers, Midwest markets, by calendar and fiscal year, since 1990", + "value": "table_31b" + }, + { + "label": "Table 54: Mexico's price of est\u00e1ndar (standard) sugar, wholesale center, Mexico City, monthly and by calendar and fiscal year, since 1994", + "value": "table_54" + }, + { + "label": "Table 55: Mexico's price of refinada (refined) sugar, wholesale center, Mexico City, monthly and by calendar and fiscal year, since 1994", + "value": "table_55" + }, + { + "label": "Table 14: U.S. sugarbeet: area planted (1,000 acres), area harvested (1,000 acres), yield per acre (short tons per acre), and production (1,000 short tons), by State and region, by crop year, since 1980/81", + "value": "table_14" + }, + { + "label": "Table 15: U.S. sugarcane: area, yield, production, sugar output, recovery rate, and sugar yield per acre, by crop year and fiscal year (Louisiana only)", + "value": "table_15" + }, + { + "label": "Table 16: U.S. beet and cane sugar production (including Puerto Rico), by fiscal year and share of total, since 1969/70", + "value": "table_16" + }, + { + "label": "Table 17: U.S. sugarbeet area, yield, and production, by crop year and fiscal year, since 1980/81", + "value": "table_17" + }, + { + "label": "Table 18: U.S. production of beet sugar and cane sugar by State, monthly, quarterly, and by calendar year and fiscal year, since 1992 (1,000 short tons, raw value)", + "value": "table_18" + }, + { + "label": "Table 19: U.S. cane and beet sugar deliveries and exports, monthly, quarterly, and by calendar year and fiscal year, since 1992 (1,000 short tons, raw value)", + "value": "table_19" + }, + { + "label": "Table 20a: U.S. sugar deliveries for human consumption by type of user, by calendar year, since 1949 (1,000 short tons, refined value)", + "value": "table_20a" + }, + { + "label": "Table 20b: U.S. sugar deliveries for human consumption by type of user, monthly and quarterly, since 2001 (1,000 short tons, refined value)", + "value": "table_20b" + }, + { + "label": "Table 21: U.S. sugar deliveries: industrial and nonindustrial uses by region, monthly, quarterly, and by calendar year (1,000 short tons, refined value)", + "value": "table_21" + }, + { + "label": "Table 22: U.S. sugar stocks held by primary distributors, quarterly (1,000 short tons, raw value)", + "value": "table_22" + }, + { + "label": "Table 46: U.S. honey production, imports, exports, stocks, and average price, by calendar year, since 1986", + "value": "table_46" + }, + { + "label": "Table 47: Honey: number of colonies, yield, production, stocks, price, and value by top producing States and United States, by calendar year, since 1986", + "value": "table_47" + }, + { + "label": "Table 48a: U.S. honey imports, by country of source, calendar year, since 1989, metric tons", + "value": "table_48a" + }, + { + "label": "Table 48b: U.S. honey imports, by country of source, calendar year, since 1989, million pounds", + "value": "table_48b" + }, + { + "label": "Table 49: U.S. total estimated deliveries of caloric sweeteners for domestic food and beverage use (1,000 short tons, dry basis), by calendar year, since 1966", + "value": "table_49" + }, + { + "label": "Table 50: U.S. per capita caloric sweeteners estimated deliveries for domestic food and beverage use (pounds, dry basis), by calendar year, since 1966", + "value": "table_50" + }, + { + "label": "Table 51: Refined cane and beet sugar: estimated number of per capita calories consumed daily, by calendar year, since 1970", + "value": "table_51" + }, + { + "label": "Table 52: High-fructose corn syrup: estimated number of per capita calories consumed daily, by calendar year, since 1970", + "value": "table_52" + }, + { + "label": "Table 53: Other sweeteners: estimated number of per capita calories consumed daily, by calendar year, since 1970", + "value": "table_53" + }, + { + "label": "Table 24a: U.S. sugar: supply and use (including Puerto Rico), by fiscal year, 1,000 short tons, raw value, since 2000/01", + "value": "table_24a" + }, + { + "label": "Table 24b: U.S. sugar: supply and use (including Puerto Rico), by fiscal year, 1,000 metric tons, raw value, since 2000/01", + "value": "table_24b" + }, + { + "label": "Table 25: Monthly estimates of U.S. sugar supply and use (1,000 short tons, raw value)", + "value": "table_25" + }, + { + "label": "Table 26: Monthly estimates of Mexican sugar supply and use (1,000 metric tons, actual weight)", + "value": "table_26" + }, + { + "label": "Table 56a: Mexico: sugar production and supply, and sugar and high-fructose corn syrup utilization, by fiscal year, 1,000 metric tons, tel quel, since 1995/96", + "value": "table_56a" + }, + { + "label": "Table 56b: Mexico: sugar production and supply, and sugar and high-fructose corn syrup utilization, by fiscal year, 1,000 metric tons, raw value, since 1995/96", + "value": "table_56b" + }, + { + "label": "Table 27: U.S. use of field corn, by marketing year, since 1990/91 (million bushels)", + "value": "table_27" + }, + { + "label": "Table 28: U.S. high-fructose corn syrup (HFCS) deliveries, quarterly, by fiscal and calendar year, since 1992 (1,000 short tons, dry weight)", + "value": "table_28" + }, + { + "label": "Table 29: U.S. high-fructose corn syrup (HFCS) production, quarterly, by fiscal and calendar year, since 1992 (1,000 short tons, dry weight)", + "value": "table_29" + }, + { + "label": "Table 30: U.S. high-fructose corn syrup supply and use, by calendar and fiscal year, since 1992 (1,000 short tons, dry weight)", + "value": "table_30" + }, + { + "label": "Table 34a: U.S. exports of high-fructose corn syrup to Mexico, since 1995 (metric tons, dry weight basis)", + "value": "table_34a" + }, + { + "label": "Table 34b: U.S. exports of high-fructose corn syrup to all countries, since 1995 (metric tons, dry weight basis)", + "value": "table_34b" + }, + { + "label": "Table 35a: Mexican imports of high-fructose corn syrup from the United States, since 1995 (metric tons, dry weight basis)", + "value": "table_35a" + }, + { + "label": "Table 35b: Mexican imports of high-fructose corn syrup from all countries, since 1995 (metric tons, dry weight basis)", + "value": "table_35b" + }, + { + "label": "Table 36: U.S. corn refinery exports, by calendar year, since 1980 (metric tons)", + "value": "table_36" + }, + { + "label": "Table 37: U.S. dextrose supply and use, by calendar year, since 1964 (1,000 short tons, dry weight)", + "value": "table_37" + }, + { + "label": "Table 38: U.S. glucose supply and use, by calendar year, since 1964 (1,000 short tons, dry weight)", + "value": "table_38" + }, + { + "label": "Table 57: U.S. raw sugar tariff-rate quota World Trade Organization allocations, entries, and shortfalls, by fiscal year quota, since 1996 (metric tons, raw value)", + "value": "table_57" + }, + { + "label": "Table 58a: U.S. refined sugar tariff-rate quota World Trade Organization allocations and entries by month, since fiscal year quota 2008 (metric tons, raw value)", + "value": "table_58a" + }, + { + "label": "Table 58b: U.S. refined sugar tariff-rate quota World Trade Organization allocations and entries, fiscal year 2007 (metric tons, raw value)", + "value": "table_58b" + }, + { + "label": "Table 58c: U.S. refined sugar tariff-rate quota World Trade Organization allocations and entries, fiscal year 2006 (metric tons, raw value)", + "value": "table_58c" + }, + { + "label": "Table 59a: U.S. sugar tariff-rate quota allocations and entries by month under free trade agreements, since fiscal year 2008 (metric tons, raw value)", + "value": "table_59a" + }, + { + "label": "Table 59b: U.S. sugar tariff-rate quota annual allocations and entries under free trade agreements, fiscal years 2006 and 2007 (metric tons, raw value)", + "value": "table_59b" + }, + { + "label": "Table 60a: U.S. imports of sugar from Mexico, monthly, since fiscal year 2011, metric tons, commercial weight", + "value": "table_60a" + }, + { + "label": "Table 60b: U.S. imports of sugar from Mexico, monthly, since fiscal year 2011, metric tons, raw value", + "value": "table_60b" + }, + { + "label": "Table 60c: U.S. imports of sugar from Mexico, monthly, fiscal years 2008 to 2010, metric tons, raw value", + "value": "table_60c" + }, + { + "label": "Table 60d: U.S. imports of sugar from Mexico by port, monthly, since fiscal year 2011, metric tons, commercial weight", + "value": "table_60d" + }, + { + "label": "Table 60e: U.S. imports of sugar from Mexico by port, fiscal year, since fiscal year 2011, metric tons, commercial weight", + "value": "table_60e" + }, + { + "label": "Table 61a: U.S. monthly sugar imports by source, since fiscal year 2008 (metric tons, raw value)", + "value": "table_61a" + }, + { + "label": "Table 61b: U.S. monthly sugar imports by source, since fiscal year 2008 (short tons, raw value)", + "value": "table_61b" + } + ], + "style": { + "popupWidth": 740 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Period basis to keep, one of the bases the selected table publishes, e.g. 'Calendar year', 'Fiscal year', 'Calendar year quarter', or 'Month'. Filtering to one basis yields a single aligned time series. If None, the table's first annual basis is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/sugar_frequencies", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SugarSweetenersYearbook", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual bases ('2020'), the year and month or quarter for sub-annual bases ('2020 Jan', '2020 Q1'), with any varying commodity, geography, or source dimension prefixed so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 320 + } + } + } + ] + }, + "model": "SugarSweetenersYearbook", + "openapi_extra": { + "model": "SugarSweetenersYearbook" + } + }, + "/usda/oil_crops_frequencies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the observation frequencies an Oil Crops Yearbook table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key from OIL_CROPS_TABLES. When absent, the default table is used.", + "default": "soybeans_supply_disappearance_price", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/oil_crops_yearbook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Oil Crops Yearbook data - the U.S. and world oilseed, oilmeal, and vegetable-oil supply, use, price, and trade tables, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.oil_crops_yearbook(provider='usda')\n# Get U.S. soybean exports by destination since 2015.\nobb.usda.oil_crops_yearbook(table='soybean_exports_by_destination', start_year=2015, provider='usda')\n# Get world oilseed supply and distribution, by oilseed.\nobb.usda.oil_crops_yearbook(table='world_oilseed_supply_and_distribution', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Oil Crops Yearbook table to retrieve. Each table is a set of named supply, use, price, or trade series indexed by year, and sometimes by month or quarter; the series spread into value columns while time stays in the rows. Valid tables are:\n soybean_stocks_quarterly, soybeans_acreage_production_yield_value, soybeans_supply_disappearance_price, soybean_meal_supply_disappearance_price, soybean_oil_supply_disappearance_price, soybeans_supply_disappearance_by_quarter, soybean_meal_supply_disappearance_by_month, soybean_oil_supply_disappearance_by_month, soybean_crush_value_price_spread, peanuts_acreage_production_yield_value, peanuts_supply_disappearance_price, peanuts_food_use, peanuts_planted_acreage_by_state, peanuts_harvested_acreage_by_state, peanuts_production_by_state, peanuts_yield_by_state, cottonseed_acreage_production_yield_value, cottonseed_supply_disappearance_price, cottonseed_meal_supply_disappearance_price, cottonseed_oil_supply_disappearance_price, sunflowerseed_acreage_production_yield_value, sunflowerseed_supply_disappearance_price, sunflowerseed_meal_supply_disappearance_price, sunflowerseed_oil_supply_disappearance_price, canola_seed_supply_disappearance_price, canola_oil_supply_disappearance_price, canola_meal_supply_disappearance_price, flaxseed_acreage_production_yield_value, flaxseed_supply_disappearance_price, linseed_meal_supply_disappearance_price, linseed_oil_supply_disappearance_price, edible_fats_and_oils_supply_disappearance, corn_oil_supply_disappearance_price, prices_received_by_farmers, prices_terminal_markets, prices_oilmeals, prices_fats_and_oils_wholesale, prices_producer_price_indexes, lard_supply_disappearance_price, edible_tallow_supply_disappearance_price, world_soybean_complex_supply_and_use, soybean_exports_by_destination, soybean_meal_exports_by_destination, soybean_oil_exports_by_destination, world_oilseed_supply_and_distribution, world_vegetable_oils_supply_and_distribution, world_protein_meal_supply_and_distribution", + "default": "soybeans_supply_disappearance_price", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "soybeans_supply_disappearance_price", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Soybean stocks: U.S. on-farm, off-farm, and total, by quarter", + "value": "soybean_stocks_quarterly" + }, + { + "label": "Soybeans: U.S. acreage, yield, production, and value", + "value": "soybeans_acreage_production_yield_value" + }, + { + "label": "Soybeans: U.S. supply, disappearance, and price", + "value": "soybeans_supply_disappearance_price" + }, + { + "label": "Soybean meal: U.S. supply, disappearance, and price", + "value": "soybean_meal_supply_disappearance_price" + }, + { + "label": "Soybean oil: U.S. supply, disappearance, and price", + "value": "soybean_oil_supply_disappearance_price" + }, + { + "label": "Soybeans: U.S. supply and disappearance, by crop-year quarter", + "value": "soybeans_supply_disappearance_by_quarter" + }, + { + "label": "Soybean meal: U.S. supply and disappearance, by month", + "value": "soybean_meal_supply_disappearance_by_month" + }, + { + "label": "Soybean oil: U.S. supply and disappearance, by month", + "value": "soybean_oil_supply_disappearance_by_month" + }, + { + "label": "Soybeans: value of products per bushel crushed and spot price spread", + "value": "soybean_crush_value_price_spread" + }, + { + "label": "Peanuts: U.S. acreage, yield, production, and value", + "value": "peanuts_acreage_production_yield_value" + }, + { + "label": "Peanuts (farmers' stock basis): U.S. supply, disappearance, and price", + "value": "peanuts_supply_disappearance_price" + }, + { + "label": "Peanuts: U.S. food uses, shelled basis", + "value": "peanuts_food_use" + }, + { + "label": "Peanuts: U.S. planted acreage, by State and region", + "value": "peanuts_planted_acreage_by_state" + }, + { + "label": "Peanuts: U.S. harvested acreage, by State and region", + "value": "peanuts_harvested_acreage_by_state" + }, + { + "label": "Peanuts: U.S. production, by State and region", + "value": "peanuts_production_by_state" + }, + { + "label": "Peanuts: U.S. yield per harvested acre, by State and region", + "value": "peanuts_yield_by_state" + }, + { + "label": "Cottonseed: U.S. acreage, yield, production, and value", + "value": "cottonseed_acreage_production_yield_value" + }, + { + "label": "Cottonseed: U.S. supply, disappearance, and price", + "value": "cottonseed_supply_disappearance_price" + }, + { + "label": "Cottonseed meal: U.S. supply, disappearance, and price", + "value": "cottonseed_meal_supply_disappearance_price" + }, + { + "label": "Cottonseed oil: U.S. supply, disappearance, and price", + "value": "cottonseed_oil_supply_disappearance_price" + }, + { + "label": "Sunflowerseed: U.S. acreage, yield, production, and value, by type", + "value": "sunflowerseed_acreage_production_yield_value" + }, + { + "label": "Sunflowerseed: U.S. supply, disappearance, and price", + "value": "sunflowerseed_supply_disappearance_price" + }, + { + "label": "Sunflowerseed meal: U.S. supply, disappearance, and price", + "value": "sunflowerseed_meal_supply_disappearance_price" + }, + { + "label": "Sunflowerseed oil: U.S. supply, disappearance, and price", + "value": "sunflowerseed_oil_supply_disappearance_price" + }, + { + "label": "Canola seed: U.S. acreage, supply, disappearance, price, and value", + "value": "canola_seed_supply_disappearance_price" + }, + { + "label": "Canola oil: U.S. supply, disappearance, and price", + "value": "canola_oil_supply_disappearance_price" + }, + { + "label": "Canola meal: U.S. supply, disappearance, and price", + "value": "canola_meal_supply_disappearance_price" + }, + { + "label": "Flaxseed: U.S. acreage, yield, production, and value", + "value": "flaxseed_acreage_production_yield_value" + }, + { + "label": "Flaxseed: U.S. supply, disappearance, and price", + "value": "flaxseed_supply_disappearance_price" + }, + { + "label": "Linseed meal: U.S. supply, disappearance, and price", + "value": "linseed_meal_supply_disappearance_price" + }, + { + "label": "Linseed oil: U.S. supply, disappearance, and price", + "value": "linseed_oil_supply_disappearance_price" + }, + { + "label": "Edible fats and oils: U.S. supply and disappearance, by product", + "value": "edible_fats_and_oils_supply_disappearance" + }, + { + "label": "Corn oil: U.S. supply, disappearance, and price", + "value": "corn_oil_supply_disappearance_price" + }, + { + "label": "Prices received by U.S. farmers, by month", + "value": "prices_received_by_farmers" + }, + { + "label": "Cash prices at terminal markets, by month", + "value": "prices_terminal_markets" + }, + { + "label": "Oilmeal prices, by month", + "value": "prices_oilmeals" + }, + { + "label": "Wholesale prices of fats and oils, by month", + "value": "prices_fats_and_oils_wholesale" + }, + { + "label": "Producer price indexes for fats and oils products, by month", + "value": "prices_producer_price_indexes" + }, + { + "label": "Lard: U.S. supply, disappearance, and price", + "value": "lard_supply_disappearance_price" + }, + { + "label": "Edible tallow: U.S. supply, disappearance, and price", + "value": "edible_tallow_supply_disappearance_price" + }, + { + "label": "World soybean, meal, and oil supply and use, by region", + "value": "world_soybean_complex_supply_and_use" + }, + { + "label": "U.S. soybean exports, by selected destination", + "value": "soybean_exports_by_destination" + }, + { + "label": "U.S. soybean meal exports, by selected destination", + "value": "soybean_meal_exports_by_destination" + }, + { + "label": "U.S. soybean oil exports, by selected destination", + "value": "soybean_oil_exports_by_destination" + }, + { + "label": "World oilseed supply and distribution, by oilseed", + "value": "world_oilseed_supply_and_distribution" + }, + { + "label": "World vegetable oils supply and distribution, by oil", + "value": "world_vegetable_oils_supply_and_distribution" + }, + { + "label": "World protein meal supply and distribution, by meal", + "value": "world_protein_meal_supply_and_distribution" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Observation frequency to keep, one of the frequencies the selected table publishes: 'point_in_time', 'annual', 'quarterly', or 'monthly'. Filtering to one frequency yields a single aligned time series. If None, the table's default frequency is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/oil_crops_frequencies", + "optionsParams": { + "table": "$table" + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the first four digits of the marketing or calendar year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the first four digits of the marketing or calendar year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "OilCropsYearbook", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the marketing or calendar year for annual tables ('2024/25'), the year and month, quarter, or stocks date for sub-annual tables ('2024/25 October', '2024/25 March 1'), with any varying commodity or geography prefixed so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 320 + } + } + } + ] + }, + "model": "OilCropsYearbook", + "openapi_extra": { + "model": "OilCropsYearbook" + } + }, + "/usda/feed_grains_database": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS feed grains data - the Feed Grains Yearbook acreage, supply, use, price, and trade tables, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.feed_grains_database(provider='usda')\n# Get corn and sorghum farm prices since 1990.\nobb.usda.feed_grains_database(table='corn_and_sorghum_farm_prices', start_year=1990, provider='usda')\n# Get U.S. corn and sorghum exports by selected destinations.\nobb.usda.feed_grains_database(table='corn_and_sorghum_exports_by_destination', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Feed Grains Yearbook table to retrieve. Each table is a set of named balance-sheet, price, or trade series indexed by year and period; the series become the wide value columns while any varying commodity, geography, and period are folded into a single pinned period label so each row is uniquely identified. Valid tables are:\n acreage_production_and_price, foreign_coarse_grains_supply_and_use, feed_grains_supply_and_use, corn_supply_and_use, sorghum_supply_and_use, barley_supply_and_use, oats_supply_and_use, hay_production_and_stocks, corn_and_sorghum_farm_prices, barley_and_oats_farm_prices, hay_farm_prices, corn_cash_prices, sorghum_cash_prices, barley_and_oats_cash_prices, feed_price_ratios, byproduct_feed_prices, processed_corn_product_prices, corn_and_sorghum_exports, barley_and_oats_exports, corn_and_sorghum_imports, barley_and_oats_imports, corn_and_sorghum_exports_by_destination, barley_and_oats_exports_by_destination, corn_and_sorghum_imports_by_source, barley_and_oats_imports_by_source, white_corn_exports_by_destination, world_coarse_grain_trade, rail_rates_and_grain_shipments, processed_feeds_fed, animal_unit_indexes, corn_food_seed_and_industrial_use, ethanol_exports_by_destination, ethanol_imports_by_source, distillers_dregs_exports_by_destination, distillers_dregs_imports_by_source", + "default": "corn_supply_and_use", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "corn_supply_and_use", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 1--Corn, sorghum, barley, and oats: Planted acreage, harvested acreage, production, yield, and price received by farmers", + "value": "acreage_production_and_price" + }, + { + "label": "Table 2--Foreign coarse grains: Supply and disappearance", + "value": "foreign_coarse_grains_supply_and_use" + }, + { + "label": "Table 3--Feed grains (corn, sorghum, barley, and oats): Supply and disappearance, million metric tons", + "value": "feed_grains_supply_and_use" + }, + { + "label": "Table 4--Corn: Supply and disappearance, million bushels", + "value": "corn_supply_and_use" + }, + { + "label": "Table 5--Sorghum: Supply and disappearance, million bushels", + "value": "sorghum_supply_and_use" + }, + { + "label": "Table 6--Barley: Supply and disappearance, million bushels", + "value": "barley_supply_and_use" + }, + { + "label": "Table 7--Oats: Supply and disappearance, million bushels", + "value": "oats_supply_and_use" + }, + { + "label": "Table 8--Hay: Production, harvested acreage, yield, and stocks", + "value": "hay_production_and_stocks" + }, + { + "label": "Table 9--Corn and sorghum: Prices received by farmers, United States", + "value": "corn_and_sorghum_farm_prices" + }, + { + "label": "Table 10--Barley and oats: Prices received by farmers, United States, dollars per bushel", + "value": "barley_and_oats_farm_prices" + }, + { + "label": "Table 11--Hay: Prices received by farmers, United States, dollars per ton", + "value": "hay_farm_prices" + }, + { + "label": "Table 12--Corn: Cash prices at principal markets, dollars per bushel", + "value": "corn_cash_prices" + }, + { + "label": "Table 13--Sorghum: Cash prices at principal markets, dollars per hundredweight", + "value": "sorghum_cash_prices" + }, + { + "label": "Table 14--Barley and Oats: Cash prices at principal markets, dollars per bushel", + "value": "barley_and_oats_cash_prices" + }, + { + "label": "Table 15--Feed-price ratios for livestock, poultry, and milk", + "value": "feed_price_ratios" + }, + { + "label": "Table 16--Byproduct feeds: Wholesale price, bulk, specified markets, dollars per ton", + "value": "byproduct_feed_prices" + }, + { + "label": "Table 17--Processed corn products: Quoted market prices", + "value": "processed_corn_product_prices" + }, + { + "label": "Table 18--U.S. corn and sorghum exports", + "value": "corn_and_sorghum_exports" + }, + { + "label": "Table 19--U.S. barley and oats exports", + "value": "barley_and_oats_exports" + }, + { + "label": "Table 20--U.S. corn and sorghum imports", + "value": "corn_and_sorghum_imports" + }, + { + "label": "Table 21--U.S. barley and oats imports", + "value": "barley_and_oats_imports" + }, + { + "label": "Table 22--U.S. corn and sorghum exports by selected destinations", + "value": "corn_and_sorghum_exports_by_destination" + }, + { + "label": "Table 23--U.S. barley and oats exports by selected destinations", + "value": "barley_and_oats_exports_by_destination" + }, + { + "label": "Table 24--U.S. corn and sorghum imports by selected sources", + "value": "corn_and_sorghum_imports_by_source" + }, + { + "label": "Table 25--U.S. barley and oats imports by selected sources", + "value": "barley_and_oats_imports_by_source" + }, + { + "label": "Table 26--U.S. white corn exports by selected destinations", + "value": "white_corn_exports_by_destination" + }, + { + "label": "Table 27--World coarse grain trade: Selected exporters and importers by commodity", + "value": "world_coarse_grain_trade" + }, + { + "label": "Table 28--Rail rates and grain shipments", + "value": "rail_rates_and_grain_shipments" + }, + { + "label": "Table 29--Processed feeds: Quantities fed and feed per grain-consuming animal unit, 1,000 metric tons", + "value": "processed_feeds_fed" + }, + { + "label": "Table 30--Indexes of feed consuming animal units, millions", + "value": "animal_unit_indexes" + }, + { + "label": "Table 31--Corn: Food, seed, and industrial use, million bushels", + "value": "corn_food_seed_and_industrial_use" + }, + { + "label": "Table 32--U.S. exports of ethyl alcohol by selected destinations", + "value": "ethanol_exports_by_destination" + }, + { + "label": "Table 33--U.S. imports of ethyl alcohol by selected sources", + "value": "ethanol_imports_by_source" + }, + { + "label": "Table 34--U.S. exports of brewers' and distillers' dregs and waste by selected destination", + "value": "distillers_dregs_exports_by_destination" + }, + { + "label": "Table 35--U.S. imports of brewers' and distillers' dregs and waste by selected sources", + "value": "distillers_dregs_imports_by_source" + } + ], + "style": { + "popupWidth": 460 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the integer year of the observation. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the integer year of the observation. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FeedGrainsDatabase", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year and published period token ('1975 Marketing year Sep-Aug', '2020 Sep', '2019 Marketing year Q1 Sep-Nov'), with any varying commodity group, commodity, or geography prefixed so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 320 + } + } + } + ] + }, + "model": "FeedGrainsDatabase", + "openapi_extra": { + "model": "FeedGrainsDatabase" + } + }, + "/usda/fruit_yearbook_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the Fruit and Tree Nuts Yearbook tables, narrowed to a category.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "category", + "type": "str", + "description": "Letter category A through H. When None, every table is returned.", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/fruit_and_tree_nuts_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS fruit and tree nuts data - the Fruit and Tree Nuts Yearbook area, production, price, supply, per-capita availability, and import-share tables, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.fruit_and_tree_nuts_data(provider='usda')\n# Get U.S. apple production, utilization, and grower price since 2010.\nobb.usda.fruit_and_tree_nuts_data(table='B-3', start_year=2010, provider='usda')\n# Get the tree-nut area-bearing table, one column per nut.\nobb.usda.fruit_and_tree_nuts_data(category='F', table='F-1', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "category", + "type": "str | None", + "description": "Yearbook table category, used to narrow the table list. Valid categories are:\n A (U.S. summary and per-capita availability), B (Noncitrus fruit), C (Citrus), D (Berries), E (Melons), F (Tree nuts), G (Supply and per-capita availability), H (Import share)", + "default": "A", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Category", + "value": "A", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "A - U.S. summary and per-capita availability", + "value": "A" + }, + { + "label": "B - Noncitrus fruit", + "value": "B" + }, + { + "label": "C - Citrus", + "value": "C" + }, + { + "label": "D - Berries", + "value": "D" + }, + { + "label": "E - Melons", + "value": "E" + }, + { + "label": "F - Tree nuts", + "value": "F" + }, + { + "label": "G - Supply and per-capita availability", + "value": "G" + }, + { + "label": "H - Import share", + "value": "H" + } + ], + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "table", + "type": "str | None", + "description": "Yearbook table to retrieve, by its short code. Each of the 152 tables shares one long schema and is pivoted to a wide layout where the measure dimensions become value columns, with the unit in each column header. Valid tables are:\n A-1, A-2, A-3, A-4, A-5, A-6, A-7, A-8, A-9, A-10, A-11, A-12, A-13, A-14, A-15, B-1, B-2, B-3, B-4, B-5, B-6, B-7, B-8, B-9, B-10, B-11, B-12, B-13, B-14, B-15, B-16, B-17, B-18, B-19, B-20, B-21, B-22, B-23, B-24, B-25, B-26, B-27, B-28, B-29, C-1, C-2, C-3, C-4, C-5, C-6, C-7, C-8, C-9, C-10, C-11, C-12, C-13, C-14, C-15, C-16, C-17, C-18, C-19, C-20, D-1, D-2, D-3, D-4, D-5, D-6, D-7, D-8, D-9, D-10, E-1, E-2, E-3, E-4, E-5, E-6, E-7, E-8, E-9, E-10, F-1, F-2, F-3, F-4, F-5, F-6, F-7, F-8, F-9, F-10, F-11, F-12, F-13, F-14, F-15, F-16, F-17, F-18, G-1, G-2, G-3, G-4, G-5, G-6, G-7, G-8, G-9, G-10, G-11, G-12, G-13, G-14, G-15, G-16, G-17, G-18, G-19, G-20, G-21, G-22, G-23, G-24, G-25, G-26, G-27, G-28, G-29, G-30, G-31, G-32, G-33, G-34, G-35, G-36, G-37, G-38, G-39, G-40, G-41, G-42, G-43, G-44, G-45, H-1, H-2, H-3, H-4, H-5", + "default": "A-1", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "A-1", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/fruit_yearbook_tables", + "optionsParams": { + "category": "$category" + }, + "style": { + "popupWidth": 640 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the first four digits of the calendar or marketing year label. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the first four digits of the calendar or marketing year label. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FruitAndTreeNutsData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "str", + "description": "Period label of the observation, as published: a calendar year such as '1980', a marketing year such as '1980/81', or, on the tables that break a measure out by commodity down the rows, the commodity prefixed to that period.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 260 + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity of the observation, as published. Present only when the table breaks a measure out by commodity down the rows; otherwise the commodities are the value columns.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "pinned": "left", + "hide": true + } + } + }, + { + "name": "month", + "type": "str | None", + "description": "Month of the observation, for the monthly price tables. Absent on the annual tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "pinned": "left", + "maxWidth": 120, + "hide": true + } + } + } + ] + }, + "model": "FruitAndTreeNutsData", + "openapi_extra": { + "model": "FruitAndTreeNutsData" + } + }, + "/usda/vegetables_and_pulses": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS vegetables and pulses yearbook data - U.S. and world vegetable and pulse-crop supply, availability, per capita use, price, trade, and cash receipts, each table pivoted to a wide layout with the data elements as columns and years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.vegetables_and_pulses(provider='usda')\n# Get the U.S. fresh asparagus balance sheet since 2015.\nobb.usda.vegetables_and_pulses(table='Table13_Asparagus', start_year=2015, provider='usda')\n# Get selected world vegetable production since 2020.\nobb.usda.vegetables_and_pulses(table='Table09_WorldVegProduction', start_year=2020, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Yearbook table to retrieve. Each table is a supply, availability, price, cash-receipts, or world-production series for one commodity or aggregate; the data elements (production, supply, imports, exports, availability, price) become the wide columns while year, commodity, and location stay as rows. Valid tables are:\n Table09_WorldVegProduction, Table10_CashReceipts, Table11_TotalFresh, Table12_Artichokes, Table13_Asparagus, Table14_Broccoli, Table15_BrusselsSprouts, Table16_Cabbage, Table17_Carrots, Table18_Cauliflower, Table19_Celery, Table20_CollardGreens, Table21_Cucumbers, Table22_Eggplant, Table23_EscaroleandEndive, Table24_Garlic, Table25_HeadLettuce, Table26_LeafandRomaine, Table27_Kale, Table28_Mushrooms, Table29_MustardGreens, Table30_Okra, Table31_Onions, Table32_PeppersBell, Table33_Potatoes, Table34_Pumpkins, Table35_Radishes, Table36_SnapBeans, Table37_Spinach, Table38_Squash, Table39_SweetCorn, Table40_SweetPotatoes, Table41_Tomatoes, Table42_TurnipGreens, Table43_TotalVeg_Pr, Table44a_Asparagus_Pr, Table44b_Asparagus_Cn, Table44c_Asparagus_Fz, Table45_Broccoli_Pr, Table46_Cabbage_Pr, Table47a_Carrots_Pr, Table47b_Carrots_Fz, Table47c_Carrots_Cn, Table48_Cauliflower_Pr, Table49_Cucumbers_Pr, Table50a_GreenLimaBeans_Pr, Table50b_GreenLimaBeans_Cn, Table50c_GreenLimaBeans_Fz, Table51_Mushrooms_Pr, Table52_Onions_Dehy, Table53a_GreenPeas_Pr, Table53b_GreenPeas_Cn, Table53c_GreenPeas_Fz, Table54_ChiliPeppers_Pr, Table55a_Potatoes_Cn, Table55b_Potatoes_Chip, Table55c_Potatoes_Dehy, Table55d_Potatoes_Fz, Table56a_SnapBeans_Pr, Table56b_SnapBeans_Cn, Table56c_SnapBeans_Fz, Table57a_Spinach_Pr, Table57b_Spinach_Cn, Table57c_Spinach_Fz, Table58a_SweetCorn_Pr, Table58b_SweetCorn_Cn, Table58c_SweetCorn_Fz, Table59_Tomatoes_Pr, Table60_AllDryBeans, Table61_Pinto, Table62_Navy, Table63_GreatNorthern, Table64_Black, Table65_Lima, Table66_RedKidney, Table67_Blackeye, Table68_Garbanzo, Table69_SmallWhite, Table70_SmallRed, Table71_Pink, Table72_Other", + "default": "Table33_Potatoes", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "Table33_Potatoes", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Selected vegetable production in leading countries and the world", + "value": "Table09_WorldVegProduction" + }, + { + "label": "Vegetables and pulse crops: U.S. farm cash receipts", + "value": "Table10_CashReceipts" + }, + { + "label": "U.S. fresh market vegetables: supply, availability, and farm weight", + "value": "Table11_TotalFresh" + }, + { + "label": "U.S. artichokes, all uses: supply, availability, price, and farm weight", + "value": "Table12_Artichokes" + }, + { + "label": "U.S. fresh asparagus: supply, availability, price, and farm weight", + "value": "Table13_Asparagus" + }, + { + "label": "U.S. fresh broccoli: supply, availability, price, and farm weight", + "value": "Table14_Broccoli" + }, + { + "label": "U.S. brussels sprouts, all uses: supply, availability, price, and farm weight", + "value": "Table15_BrusselsSprouts" + }, + { + "label": "U.S. cabbage: supply, availability, price, and farm weight", + "value": "Table16_Cabbage" + }, + { + "label": "U.S. fresh carrots: supply, availability, price, and farm weight", + "value": "Table17_Carrots" + }, + { + "label": "U.S. fresh cauliflower: supply, availability, price, and farm weight", + "value": "Table18_Cauliflower" + }, + { + "label": "U.S. celery, all uses: supply, availability, price, and farm weight", + "value": "Table19_Celery" + }, + { + "label": "U.S. collard greens, all uses: supply, availability, price, and farm weight", + "value": "Table20_CollardGreens" + }, + { + "label": "U.S. fresh cucumbers: supply, availability, price, and farm weight", + "value": "Table21_Cucumbers" + }, + { + "label": "U.S. eggplant, all uses: supply, availability, price, and farm weight", + "value": "Table22_Eggplant" + }, + { + "label": "U.S. escarole and endive, all uses: supply, availability, price, and farm weight", + "value": "Table23_EscaroleandEndive" + }, + { + "label": "U.S. garlic, all uses: supply, availability, price, and farm weight", + "value": "Table24_Garlic" + }, + { + "label": "U.S. fresh head lettuce: supply, availability, price, and farm weight", + "value": "Table25_HeadLettuce" + }, + { + "label": "U.S. leaf and romaine lettuce: supply, availability, price, and farm weight", + "value": "Table26_LeafandRomaine" + }, + { + "label": "U.S. kale, all uses: supply, availability, price, and farm weight", + "value": "Table27_Kale" + }, + { + "label": "U.S. fresh mushrooms: supply, availability, price, and farm weight", + "value": "Table28_Mushrooms" + }, + { + "label": "U.S. mustard greens, all uses: supply, availability, price, and farm weight", + "value": "Table29_MustardGreens" + }, + { + "label": "U.S. okra, all uses: supply, availability, and farm weight", + "value": "Table30_Okra" + }, + { + "label": "U.S. fresh onions: supply, availability, price, and farm weight", + "value": "Table31_Onions" + }, + { + "label": "U.S. bell peppers, all uses: supply, availability, price, and farm weight", + "value": "Table32_PeppersBell" + }, + { + "label": "U.S. fresh potatoes: supply, availability, price, and farm weight", + "value": "Table33_Potatoes" + }, + { + "label": "U.S. pumpkins, all uses: supply, availability, and farm weight", + "value": "Table34_Pumpkins" + }, + { + "label": "U.S. radishes, all uses: supply, availability, and farm weight", + "value": "Table35_Radishes" + }, + { + "label": "U.S. fresh snap beans: supply, availability, price, and farm weight", + "value": "Table36_SnapBeans" + }, + { + "label": "U.S. fresh spinach: supply, availability, price, and farm weight", + "value": "Table37_Spinach" + }, + { + "label": "U.S. squash, all uses: supply, availability, price, and farm weight", + "value": "Table38_Squash" + }, + { + "label": "U.S. fresh sweet corn: supply, availability, price, and farm weight", + "value": "Table39_SweetCorn" + }, + { + "label": "U.S. sweet potatoes, all uses: supply, availability, price, and farm weight", + "value": "Table40_SweetPotatoes" + }, + { + "label": "U.S. fresh tomatoes: supply, availability, price, and farm weight", + "value": "Table41_Tomatoes" + }, + { + "label": "U.S. turnip greens, all: supply, availability, price, and farm weight", + "value": "Table42_TurnipGreens" + }, + { + "label": "U.S. vegetables for processing (excluding potatoes): supply, availability, and farm weight", + "value": "Table43_TotalVeg_Pr" + }, + { + "label": "U.S. asparagus for processing: supply, availability, price, and farm weight", + "value": "Table44a_Asparagus_Pr" + }, + { + "label": "U.S. asparagus for canning: supply, availability, price, and farm weight", + "value": "Table44b_Asparagus_Cn" + }, + { + "label": "U.S. asparagus for freezing: supply, availability, price, and farm weight", + "value": "Table44c_Asparagus_Fz" + }, + { + "label": "U.S. broccoli for processing: supply, availability, price, and farm weight", + "value": "Table45_Broccoli_Pr" + }, + { + "label": "U.S. cabbage for sauerkraut: supply, availability, price, and farm weight", + "value": "Table46_Cabbage_Pr" + }, + { + "label": "U.S. carrots for processing: supply, availability, price, and farm weight", + "value": "Table47a_Carrots_Pr" + }, + { + "label": "U.S. carrots for freezing: supply, availability, price, and farm weight", + "value": "Table47b_Carrots_Fz" + }, + { + "label": "U.S. carrots for canning: supply, availability, price, and farm weight", + "value": "Table47c_Carrots_Cn" + }, + { + "label": "U.S. cauliflower for processing: supply, availability, price, and farm weight", + "value": "Table48_Cauliflower_Pr" + }, + { + "label": "U.S. cucumbers for processing (largely pickling): supply, availability, price, and farm weight", + "value": "Table49_Cucumbers_Pr" + }, + { + "label": "U.S. green lima beans for processing: supply, availability, price, and farm weight", + "value": "Table50a_GreenLimaBeans_Pr" + }, + { + "label": "U.S. green lima beans for canning: supply, availability, price, and farm weight", + "value": "Table50b_GreenLimaBeans_Cn" + }, + { + "label": "U.S. green lima beans for freezing: supply, availability, price, and farm weight", + "value": "Table50c_GreenLimaBeans_Fz" + }, + { + "label": "U.S. mushrooms for processing: supply, availability, price, and farm weight", + "value": "Table51_Mushrooms_Pr" + }, + { + "label": "U.S. onions for dehydrating: supply, availability, price, and farm weight", + "value": "Table52_Onions_Dehy" + }, + { + "label": "U.S. peas (green) for processing: supply, availability, price, and farm weight", + "value": "Table53a_GreenPeas_Pr" + }, + { + "label": "U.S. peas (green) for canning: supply, availability, price, and farm weight", + "value": "Table53b_GreenPeas_Cn" + }, + { + "label": "U.S. peas (green) for freezing: supply, availability, price, and farm weight", + "value": "Table53c_GreenPeas_Fz" + }, + { + "label": "U.S. chili peppers, all uses: supply, availability, and price, farm weight", + "value": "Table54_ChiliPeppers_Pr" + }, + { + "label": "U.S. potatoes for canning: supply, availability, price, and farm weight", + "value": "Table55a_Potatoes_Cn" + }, + { + "label": "U.S. potatoes for chips and shoestrings: supply, availability, price, and farm weight", + "value": "Table55b_Potatoes_Chip" + }, + { + "label": "U.S. potatoes for dehydration: supply, availability, price, and farm weight", + "value": "Table55c_Potatoes_Dehy" + }, + { + "label": "U.S. potatoes for freezing: Supply and availability", + "value": "Table55d_Potatoes_Fz" + }, + { + "label": "U.S. snap beans for processing: supply, availability, price, and farm weight", + "value": "Table56a_SnapBeans_Pr" + }, + { + "label": "U.S. snap beans for canning: supply, availability, price, and farm weight", + "value": "Table56b_SnapBeans_Cn" + }, + { + "label": "U.S. snap beans for freezing: supply, availability, price, and farm weight", + "value": "Table56c_SnapBeans_Fz" + }, + { + "label": "U.S. spinach for processing: supply, availability, price, and farm weight", + "value": "Table57a_Spinach_Pr" + }, + { + "label": "U.S. spinach for canning: supply, availability, price, and farm weight", + "value": "Table57b_Spinach_Cn" + }, + { + "label": "U.S. spinach for freezing: supply, availability, price, and farm weight", + "value": "Table57c_Spinach_Fz" + }, + { + "label": "U.S. sweet corn for processing: supply, availability, price, and farm weight", + "value": "Table58a_SweetCorn_Pr" + }, + { + "label": "U.S. sweet corn for canning: supply, availability, price, and farm weight", + "value": "Table58b_SweetCorn_Cn" + }, + { + "label": "U.S. sweet corn for freezing: supply, availability, price, and farm weight", + "value": "Table58c_SweetCorn_Fz" + }, + { + "label": "U.S. tomatoes for processing: supply, availability, price, and farm weight", + "value": "Table59_Tomatoes_Pr" + }, + { + "label": "U.S. dry edible beans: supply, availability, and price, farm weight", + "value": "Table60_AllDryBeans" + }, + { + "label": "U.S. pinto beans, dry: supply, availability, and price, farm weight", + "value": "Table61_Pinto" + }, + { + "label": "U.S. navy beans, dry: supply, availability, and price, farm weight", + "value": "Table62_Navy" + }, + { + "label": "U.S. great northern beans, dry: supply, availability, and price, farm weight", + "value": "Table63_GreatNorthern" + }, + { + "label": "U.S. black beans, dry: supply, availability, and price, farm weight", + "value": "Table64_Black" + }, + { + "label": "U.S. lima beans, dry: supply, availability, and price, farm weight", + "value": "Table65_Lima" + }, + { + "label": "U.S. all red kidney beans, dry: supply, availability, and price, farm weight", + "value": "Table66_RedKidney" + }, + { + "label": "U.S. blackeye beans, dry: supply, availability, and price, farm weight", + "value": "Table67_Blackeye" + }, + { + "label": "U.S. garbanzo beans, dry: supply, availability, and price, farm weight", + "value": "Table68_Garbanzo" + }, + { + "label": "U.S. small white beans, dry: supply, availability, and price, farm weight", + "value": "Table69_SmallWhite" + }, + { + "label": "U.S. small red beans, dry: supply, availability, and price, farm weight", + "value": "Table70_SmallRed" + }, + { + "label": "U.S. pink beans, dry: supply, availability, and price, farm weight", + "value": "Table71_Pink" + }, + { + "label": "U.S. cranberry and other beans, dry: supply, availability, and price, farm weight", + "value": "Table72_Other" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "VegetablesAndPulses", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Vegetable or pulse commodity, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "pinned": "left" + } + } + }, + { + "name": "location", + "type": "str | None", + "description": "Location of the observation: a country for the world-production table, a state or the United States for the cash-receipts table, and the United States for the commodity supply tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Location", + "pinned": "left" + } + } + }, + { + "name": "end_use", + "type": "str | None", + "description": "Market of the observation, as published, e.g. 'Fresh', 'Processing', 'Dry', 'Canning', 'Freezing', or 'All uses'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "End use", + "hide": true + } + } + }, + { + "name": "geographical_level", + "type": "str | None", + "description": "Geographical level of the location, 'Country' or 'State'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Geographic level", + "hide": true + } + } + } + ] + }, + "model": "VegetablesAndPulses", + "openapi_extra": { + "model": "VegetablesAndPulses" + } + }, + "/usda/cotton_frequencies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the reporting frequencies a cotton, wool, or textile table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key from CWT_TABLES. When absent, the default table is used.", + "default": "cotton_supply_and_use", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/cotton_wool_and_textile_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS cotton, wool, and textile data - the Cotton and Wool Yearbook supply, use, price, and trade tables plus the raw-fiber equivalents of U.S. textile trade, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.cotton_wool_and_textile_data(provider='usda')\n# Get world cotton supply and use since 2010.\nobb.usda.cotton_wool_and_textile_data(table='world_cotton_supply_and_use', start_year=2010, provider='usda')\n# Get U.S. cotton textile and apparel imports by country of origin.\nobb.usda.cotton_wool_and_textile_data(table='rfe_cotton_textile_imports_by_origin', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Cotton, wool, and textile table to retrieve. Each table is a set of named supply-use, price, or trade series indexed by year; the series spread into the value columns while time stays in the rows, except the by-origin and by-destination cotton textile trade tables, which keep the country in the rows and spread years into columns. Valid tables are:\n cotton_supply_and_use, upland_cotton_supply_and_use, els_cotton_supply_and_use, upland_planted_acreage_by_state, upland_harvested_acreage_by_state, upland_lint_yield_by_state, upland_production_by_state, els_acreage_by_state, els_production_and_yield_by_state, cotton_supply_and_disappearance_monthly, upland_farm_spot_mill_prices, fiber_prices, cotton_price_quotes_monthly, cotton_price_quotes_annual, world_cotton_supply_and_use, foreign_cotton_supply_and_use, cotton_exports_major_exporters, cotton_imports_major_importers, former_soviet_union_cotton_supply_and_use, brazil_cotton_supply_and_use, turkey_cotton_supply_and_use, china_cotton_supply_and_use, india_cotton_supply_and_use, pakistan_cotton_supply_and_use, cotton_fiber_demand_total_and_per_capita, per_capita_cotton_demand, cotton_and_synthetic_mill_use, wool_supply_and_use, raw_wool_imports_for_mill_use, raw_wool_imports_by_origin, raw_wool_exports_by_destination, wool_tops_trade, shorn_wool_prices, mohair_exports_by_destination, raw_fiber_equivalent_textile_manufactures, raw_cotton_equivalent_imports, raw_cotton_equivalent_exports, raw_linen_equivalent_imports, raw_linen_equivalent_exports, raw_wool_equivalent_imports, raw_wool_equivalent_exports, raw_silk_equivalent_imports, raw_silk_equivalent_exports, raw_synthetic_equivalent_imports, raw_synthetic_equivalent_exports, rfe_textile_imports_by_fiber, rfe_textile_exports_by_fiber, rfe_cotton_textile_imports_by_origin, rfe_cotton_textile_exports_by_destination", + "default": "cotton_supply_and_use", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "cotton_supply_and_use", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "U.S. cotton - 1. Supply and use", + "value": "cotton_supply_and_use" + }, + { + "label": "U.S. cotton - 2. Upland supply and use", + "value": "upland_cotton_supply_and_use" + }, + { + "label": "U.S. cotton - 3. Extra Long Staple supply and use", + "value": "els_cotton_supply_and_use" + }, + { + "label": "U.S. cotton - 4. Upland planted acreage by State", + "value": "upland_planted_acreage_by_state" + }, + { + "label": "U.S. cotton - 5. Upland harvested acreage by State", + "value": "upland_harvested_acreage_by_state" + }, + { + "label": "U.S. cotton - 6. Upland lint yield by State", + "value": "upland_lint_yield_by_state" + }, + { + "label": "U.S. cotton - 7. Upland production by State", + "value": "upland_production_by_state" + }, + { + "label": "U.S. cotton - 8. Extra Long Staple acreage by State", + "value": "els_acreage_by_state" + }, + { + "label": "U.S. cotton - 9. Extra Long Staple production and yield by State", + "value": "els_production_and_yield_by_state" + }, + { + "label": "U.S. cotton - 10. Supply and disappearance, by month", + "value": "cotton_supply_and_disappearance_monthly" + }, + { + "label": "Prices - 11. Upland farm, spot, and mill prices", + "value": "upland_farm_spot_mill_prices" + }, + { + "label": "Prices - 12. Fiber prices", + "value": "fiber_prices" + }, + { + "label": "Prices - 13. Cotton price quotations, monthly", + "value": "cotton_price_quotes_monthly" + }, + { + "label": "Prices - 14. Cotton price quotations, annual", + "value": "cotton_price_quotes_annual" + }, + { + "label": "World - 15. World cotton supply and use", + "value": "world_cotton_supply_and_use" + }, + { + "label": "World - 16. Foreign cotton supply and use", + "value": "foreign_cotton_supply_and_use" + }, + { + "label": "World - 17. Exports, major foreign exporters", + "value": "cotton_exports_major_exporters" + }, + { + "label": "World - 18. Imports, major importers", + "value": "cotton_imports_major_importers" + }, + { + "label": "World - 19. Former Soviet Union supply and use", + "value": "former_soviet_union_cotton_supply_and_use" + }, + { + "label": "World - 20. Brazil supply and use", + "value": "brazil_cotton_supply_and_use" + }, + { + "label": "World - 21. Turkey supply and use", + "value": "turkey_cotton_supply_and_use" + }, + { + "label": "World - 22. China supply and use", + "value": "china_cotton_supply_and_use" + }, + { + "label": "World - 23. India supply and use", + "value": "india_cotton_supply_and_use" + }, + { + "label": "World - 24. Pakistan supply and use", + "value": "pakistan_cotton_supply_and_use" + }, + { + "label": "U.S. fiber demand - 25. Cotton fiber demand, total and per capita", + "value": "cotton_fiber_demand_total_and_per_capita" + }, + { + "label": "U.S. fiber demand - 26. Per capita domestic cotton demand", + "value": "per_capita_cotton_demand" + }, + { + "label": "U.S. fiber demand - 27. Cotton and synthetic staple mill use", + "value": "cotton_and_synthetic_mill_use" + }, + { + "label": "Wool - 28. Supply and use", + "value": "wool_supply_and_use" + }, + { + "label": "Wool - 29. Raw wool imports for mill use", + "value": "raw_wool_imports_for_mill_use" + }, + { + "label": "Wool - 30. Raw wool imports by country of origin", + "value": "raw_wool_imports_by_origin" + }, + { + "label": "Wool - 31. Raw wool exports by country of destination", + "value": "raw_wool_exports_by_destination" + }, + { + "label": "Wool - 32. Trade in wool tops", + "value": "wool_tops_trade" + }, + { + "label": "Wool - 33. Shorn wool prices", + "value": "shorn_wool_prices" + }, + { + "label": "Wool - 34. Mohair exports by country of destination", + "value": "mohair_exports_by_destination" + }, + { + "label": "Textile trade - 35. Raw-fiber equivalent of manufactures", + "value": "raw_fiber_equivalent_textile_manufactures" + }, + { + "label": "Textile trade - 36. Raw-cotton equivalent of imports", + "value": "raw_cotton_equivalent_imports" + }, + { + "label": "Textile trade - 37. Raw-cotton equivalent of exports", + "value": "raw_cotton_equivalent_exports" + }, + { + "label": "Textile trade - 38. Raw-linen equivalent of imports", + "value": "raw_linen_equivalent_imports" + }, + { + "label": "Textile trade - 39. Raw-linen equivalent of exports", + "value": "raw_linen_equivalent_exports" + }, + { + "label": "Textile trade - 40. Raw-wool equivalent of imports", + "value": "raw_wool_equivalent_imports" + }, + { + "label": "Textile trade - 41. Raw-wool equivalent of exports", + "value": "raw_wool_equivalent_exports" + }, + { + "label": "Textile trade - 42. Raw-silk equivalent of imports", + "value": "raw_silk_equivalent_imports" + }, + { + "label": "Textile trade - 43. Raw-silk equivalent of exports", + "value": "raw_silk_equivalent_exports" + }, + { + "label": "Textile trade - 44. Raw-synthetic equivalent of imports", + "value": "raw_synthetic_equivalent_imports" + }, + { + "label": "Textile trade - 45. Raw-synthetic equivalent of exports", + "value": "raw_synthetic_equivalent_exports" + }, + { + "label": "Raw-fiber equivalent - T1. Textile imports, by fiber", + "value": "rfe_textile_imports_by_fiber" + }, + { + "label": "Raw-fiber equivalent - T2. Textile exports, by fiber", + "value": "rfe_textile_exports_by_fiber" + }, + { + "label": "Raw-fiber equivalent - T3. Cotton textile imports, by origin", + "value": "rfe_cotton_textile_imports_by_origin" + }, + { + "label": "Raw-fiber equivalent - T4. Cotton textile exports, by destination", + "value": "rfe_cotton_textile_exports_by_destination" + } + ], + "style": { + "popupWidth": 480 + } + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Reporting frequency to keep, one of the frequencies the selected table publishes: 'Annual', 'Quarterly', or 'Monthly'. Filtering to one frequency yields a single aligned time series. If None, the finest frequency the table offers is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/cotton_frequencies", + "optionsParams": { + "table": "$table" + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the four-digit start year of the observation. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the four-digit start year of the observation. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CottonWoolAndTextileData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the calendar or marketing year ('2020'), the year and month for monthly tables ('2020 Jan'), the country for the by-origin and by-destination trade tables, or a country prefixed to the year where a table breaks a series out by country down the rows.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 240 + } + } + } + ] + }, + "model": "CottonWoolAndTextileData", + "openapi_extra": { + "model": "CottonWoolAndTextileData" + } + }, + "/usda/fertilizer_use_and_price": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS fertilizer use and price - U.S. nutrient and material consumption, farm prices, price indexes, and crop-by-State application rates and shares, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.fertilizer_use_and_price(provider='usda')\n# Get average U.S. farm prices of selected fertilizers since 2010.\nobb.usda.fertilizer_use_and_price(table='farm_prices', start_year=2010, provider='usda')\n# Get the percent of corn acreage receiving nitrogen, by State.\nobb.usda.fertilizer_use_and_price(table='corn_nitrogen_share', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Fertilizer table to retrieve. National tables (1-8) spread their nutrient, material, or price measures into the wide columns; crop-by-State tables (9-32) spread the surveyed States into the wide columns. The period is the pinned row axis. Valid tables are:\n us_plant_nutrient_consumption, plant_nutrient_use_by_crop, nutrient_material_class_consumption, nitrogen_material_consumption, phosphate_potash_material_consumption, secondary_micronutrient_organic_consumption, farm_prices, price_indexes, corn_nitrogen_share, corn_nitrogen_rate, corn_phosphate_share, corn_phosphate_rate, corn_potash_share, corn_potash_rate, cotton_nitrogen_share, cotton_nitrogen_rate, cotton_phosphate_share, cotton_phosphate_rate, cotton_potash_share, cotton_potash_rate, soybeans_nitrogen_share, soybeans_nitrogen_rate, soybeans_phosphate_share, soybeans_phosphate_rate, soybeans_potash_share, soybeans_potash_rate, wheat_nitrogen_share, wheat_nitrogen_rate, wheat_phosphate_share, wheat_phosphate_rate, wheat_potash_share, wheat_potash_rate", + "default": "us_plant_nutrient_consumption", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "us_plant_nutrient_consumption", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 1. U.S. consumption of plant nutrients", + "value": "us_plant_nutrient_consumption" + }, + { + "label": "Table 2. Estimated U.S. plant nutrient use by selected crops", + "value": "plant_nutrient_use_by_crop" + }, + { + "label": "Table 3. U.S. consumption of single, multiple, and secondary and micro nutrients", + "value": "nutrient_material_class_consumption" + }, + { + "label": "Table 4. U.S. consumption of selected nitrogen materials", + "value": "nitrogen_material_consumption" + }, + { + "label": "Table 5. U.S. consumption of selected phosphate and potash fertilizers", + "value": "phosphate_potash_material_consumption" + }, + { + "label": "Table 6. U.S. consumption of selected secondary, micronutrients, and natural organic materials", + "value": "secondary_micronutrient_organic_consumption" + }, + { + "label": "Table 7. Average U.S. farm prices of selected fertilizers", + "value": "farm_prices" + }, + { + "label": "Table 8. Fertilizer price indexes", + "value": "price_indexes" + }, + { + "label": "Table 9. Percent of corn acreage receiving nitrogen fertilizer, selected States", + "value": "corn_nitrogen_share" + }, + { + "label": "Table 10. Nitrogen used on corn, rate per fertilized acre receiving nitrogen, selected States", + "value": "corn_nitrogen_rate" + }, + { + "label": "Table 11. Percentage of corn acreage receiving phosphate fertilizer, selected States", + "value": "corn_phosphate_share" + }, + { + "label": "Table 12. Phosphate used on corn, rate per fertilized acre receiving phosphate fertilizer, selected States", + "value": "corn_phosphate_rate" + }, + { + "label": "Table 13. Percentage of corn acreage receiving potash fertilizer, selected States", + "value": "corn_potash_share" + }, + { + "label": "Table 14. Potash used on corn, rate per fertilized acre receiving potash, selected States", + "value": "corn_potash_rate" + }, + { + "label": "Table 15. Percentage of cotton acreage receiving nitrogen fertilizer, selected States", + "value": "cotton_nitrogen_share" + }, + { + "label": "Table 16. Nitrogen used on cotton, rate per fertilized acre receiving nitrogen, selected States", + "value": "cotton_nitrogen_rate" + }, + { + "label": "Table 17. Percentage of cotton acreage receiving phosphate fertilizer, selected States", + "value": "cotton_phosphate_share" + }, + { + "label": "Table 18. Phosphate used on cotton, rate per fertilized acre receiving phosphate, selected States", + "value": "cotton_phosphate_rate" + }, + { + "label": "Table 19. Percentage of cotton acreage receiving potash fertilizer, selected States", + "value": "cotton_potash_share" + }, + { + "label": "Table 20. Potash used on cotton, rate per fertilized acre receiving potash, selected States", + "value": "cotton_potash_rate" + }, + { + "label": "Table 21. Percentage of soybean acreage receiving nitrogen fertilizer, selected States", + "value": "soybeans_nitrogen_share" + }, + { + "label": "Table 22. Nitrogen used on soybeans, rate per fertilized acre receiving nitrogen, selected States", + "value": "soybeans_nitrogen_rate" + }, + { + "label": "Table 23. Percentage of soybean acreage receiving phosphate fertilizer, selected States", + "value": "soybeans_phosphate_share" + }, + { + "label": "Table 24. Phosphate used on soybeans, rate per fertilized acre receiving phosphate, selected States", + "value": "soybeans_phosphate_rate" + }, + { + "label": "Table 25. Percentage of soybean acreage receiving potash fertilizer, selected States", + "value": "soybeans_potash_share" + }, + { + "label": "Table 26. Potash used on soybeans, rate per fertilized acre receiving potash, selected States", + "value": "soybeans_potash_rate" + }, + { + "label": "Table 27. Percentage of wheat acreage receiving nitrogen fertilizer, selected States", + "value": "wheat_nitrogen_share" + }, + { + "label": "Table 28. Nitrogen used on wheat, rate per fertilized acre receiving nitrogen, selected States", + "value": "wheat_nitrogen_rate" + }, + { + "label": "Table 29. Percentage of wheat acreage receiving phosphate fertilizer, selected States", + "value": "wheat_phosphate_share" + }, + { + "label": "Table 30. Phosphate used on wheat, rate per fertilized acre receiving phosphate, selected States", + "value": "wheat_phosphate_rate" + }, + { + "label": "Table 31. Percentage of wheat acreage receiving potash fertilizer, selected States", + "value": "wheat_potash_share" + }, + { + "label": "Table 32. Potash used on wheat, rate per fertilized acre receiving potash, selected States", + "value": "wheat_potash_rate" + } + ], + "style": { + "popupWidth": 560 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the integer year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the integer year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FertilizerUseAndPrice", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual tables ('2015'), the year and month for the sub-annual farm-prices table ('1977 Mar.'), so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 260 + } + } + } + ] + }, + "model": "FertilizerUseAndPrice", + "openapi_extra": { + "model": "FertilizerUseAndPrice" + } + }, + "/usda/food_price_outlook": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Food Price Outlook - consumer and producer food price index forecasts, prediction intervals, and the annual percent-change record, each pivoted to a wide layout.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_price_outlook(provider='usda')\n# Get the annual consumer food price index changes since 2000.\nobb.usda.food_price_outlook(table='cpi_annual', start_year=2000, provider='usda')\n# Get the consumer forecast prediction intervals for beef and eggs.\nobb.usda.food_price_outlook(table='cpi_forecast', item='beef,eggs', provider='usda')\n# Get the historical consumer forecast vintages for all food.\nobb.usda.food_price_outlook(table='cpi_forecast_history', item='all food', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Food Price Outlook table to retrieve. The forecast tables spread each price-index measure into a column, the annual tables spread each food category into a column with years as rows, and the forecast-history tables spread the prediction-interval bounds into columns. Valid tables are:\n cpi_forecast, ppi_forecast, cpi_annual, ppi_annual, cpi_forecast_history, ppi_forecast_history", + "default": "cpi_forecast", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "cpi_forecast", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "CPI forecast - changes in consumer price indexes", + "value": "cpi_forecast" + }, + { + "label": "PPI forecast - changes in producer price indexes", + "value": "ppi_forecast" + }, + { + "label": "CPI annual - percent changes since 1974", + "value": "cpi_annual" + }, + { + "label": "PPI annual - percent changes since 1974", + "value": "ppi_annual" + }, + { + "label": "CPI forecast history - monthly vintages", + "value": "cpi_forecast_history" + }, + { + "label": "PPI forecast history - monthly vintages", + "value": "ppi_forecast_history" + } + ], + "style": { + "popupWidth": 480 + } + } + } + }, + { + "name": "item", + "type": "str | None", + "description": "Filter by a single exact price-index item as published, e.g. 'Beef and veal', scoped to the selected table. Filters rows for the forecast and forecast-history tables and value columns for the annual tables. If None, all items are included.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Item", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/food_price_outlook_items", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, applied to the annual calendar year and the forecast-history year being forecast. Forecast measures with no year, such as month-over-month changes, are always kept. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, applied to the annual calendar year and the forecast-history year being forecast. Forecast measures with no year, such as month-over-month changes, are always kept. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodPriceOutlook", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "item", + "type": "str | None", + "description": "Row label: the price-index item on the forecast and forecast-history tables, e.g. 'All food' or 'Wholesale beef', or the calendar year on the annual tables, where each food category is a value column instead.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Item", + "pinned": "left" + } + } + }, + { + "name": "top_level", + "type": "str | None", + "description": "Top level of the consumer price index hierarchy, as published. Only for the consumer forecast table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Top level", + "hide": true + } + } + }, + { + "name": "aggregate", + "type": "str | None", + "description": "Aggregate level of the consumer price index hierarchy, as published. Only for the consumer forecast table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Aggregate", + "hide": true + } + } + }, + { + "name": "mid_level", + "type": "str | None", + "description": "Mid level of the consumer price index hierarchy, as published. Only for the consumer forecast table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mid level", + "hide": true + } + } + }, + { + "name": "low_level", + "type": "str | None", + "description": "Low level of the consumer price index hierarchy, as published. Only for the consumer forecast table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Low level", + "hide": true + } + } + }, + { + "name": "disaggregate", + "type": "str | None", + "description": "Disaggregate level of the consumer price index hierarchy, as published. Only for the consumer forecast table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Disaggregate", + "hide": true + } + } + }, + { + "name": "year", + "type": "int | None", + "description": "Year of the row: the calendar year on the annual tables and the year being forecast on the forecast-history tables. Absent on the forecast tables, whose measures span several reference years.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "maxWidth": 90, + "hide": true + } + } + }, + { + "name": "forecast_date", + "type": "date | None", + "description": "Vintage of the forecast, as the first day of the month the forecast was made. Only for the forecast-history tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forecast date", + "hide": true + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the value columns, as published, when a single unit applies to the whole row. Absent on the forecast tables, whose measures carry differing units per column.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + } + ] + }, + "model": "FoodPriceOutlook", + "openapi_extra": { + "model": "FoodPriceOutlook" + } + }, + "/usda/food_price_outlook_items": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the price-index items available in a Food Price Outlook table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key. Unknown tables fall back to the CPI forecast table.", + "default": "cpi_forecast", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/fruit_and_vegetable_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS fruit and vegetable prices - 2023 average retail price, preparation yield factor, cup-equivalent size, and average price per edible cup-equivalent, one row per commodity and marketed form.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.fruit_and_vegetable_prices(provider='usda')\n# Get 2023 average retail and cup-equivalent prices for vegetables.\nobb.usda.fruit_and_vegetable_prices(table='vegetable', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Commodity group to retrieve. Each group is one tidy table of average retail and cup-equivalent prices, with one row per item and form. Valid tables are:\n fruit, vegetable", + "default": "fruit", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "fruit", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Fruit", + "value": "fruit" + }, + { + "label": "Vegetable", + "value": "vegetable" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FruitAndVegetablePrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "item", + "type": "str", + "description": "Fruit or vegetable commodity, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "cellDataType": "text", + "pinned": "left" + } + } + }, + { + "name": "form", + "type": "str", + "description": "Marketed form of the item, e.g. Fresh, Canned, Frozen, Dried, or Juice.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Form", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 120 + } + } + }, + { + "name": "average_retail_price", + "type": "float | None", + "description": "Average retail price of the item in its retail unit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Average Retail Price", + "cellDataType": "number" + } + } + }, + { + "name": "average_retail_price_unit", + "type": "str | None", + "description": "Retail unit the average retail price is measured in, e.g. 'per pound' or 'per pint (16 fluid ounces ready to drink)'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retail Price Unit", + "cellDataType": "text" + } + } + }, + { + "name": "preparation_yield_factor", + "type": "float | None", + "description": "Share of the purchased item that is edible after preparation, as a fraction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Preparation Yield Factor", + "cellDataType": "number" + } + } + }, + { + "name": "cup_equivalent_size", + "type": "float | None", + "description": "Size of one cup-equivalent of the edible item, in the cup-equivalent unit.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cup-Equivalent Size", + "cellDataType": "number" + } + } + }, + { + "name": "cup_equivalent_unit", + "type": "str | None", + "description": "Unit the cup-equivalent size is measured in, e.g. 'pounds' or 'pints'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Cup-Equivalent Unit", + "cellDataType": "text" + } + } + }, + { + "name": "average_price_per_cup_equivalent", + "type": "float | None", + "description": "Average price of one edible cup-equivalent of the item, in U.S. dollars.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Average Price per Cup-Equivalent", + "cellDataType": "number" + } + } + } + ] + }, + "model": "FruitAndVegetablePrices", + "openapi_extra": { + "model": "FruitAndVegetablePrices" + } + }, + "/usda/livestock_and_meat_domestic_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS livestock and meat domestic data - slaughter, production, weights, cold storage, supply and disappearance, and livestock and wholesale prices, each pivoted to a wide layout by attribute.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.livestock_and_meat_domestic_data(provider='usda')\n# Get red meat and poultry production since 2020.\nobb.usda.livestock_and_meat_domestic_data(table='production', start_year=2020, provider='usda')\n# Get monthly livestock prices since 2024.\nobb.usda.livestock_and_meat_domestic_data(table='livestock_prices', start_year=2024, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Livestock and meat table to retrieve. Each table is a set of named slaughter, production, weight, cold-storage, supply-and-use, or price series indexed by year and period; the attributes become the wide value columns, prefixed by commodity or sub-table where that dimension splits the series. Valid tables are:\n supply_and_disappearance, slaughter, production, live_and_dressed_weights, cold_storage, livestock_prices, wholesale_prices, feeder_cattle_outside_feedlots, heifers_entering_the_herd, high_plains_cattle_feeding_simulator", + "default": "supply_and_disappearance", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "supply_and_disappearance", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Meat supply and disappearance", + "value": "supply_and_disappearance" + }, + { + "label": "Livestock and poultry slaughter", + "value": "slaughter" + }, + { + "label": "Red meat and poultry production", + "value": "production" + }, + { + "label": "Livestock and poultry live and dressed weights", + "value": "live_and_dressed_weights" + }, + { + "label": "Red meat and poultry cold storage stocks", + "value": "cold_storage" + }, + { + "label": "Livestock prices", + "value": "livestock_prices" + }, + { + "label": "Wholesale prices", + "value": "wholesale_prices" + }, + { + "label": "Feeder cattle supplies outside feedlots", + "value": "feeder_cattle_outside_feedlots" + }, + { + "label": "Heifers entering the herd", + "value": "heifers_entering_the_herd" + }, + { + "label": "High Plains cattle feeding simulator", + "value": "high_plains_cattle_feeding_simulator" + } + ], + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "LivestockAndMeatDomesticData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual tables ('2020'), the year and month, quarter, or feeding window for sub-annual tables ('2020 January', '2020 Q1 Jan-Mar'), with any commodity, sub-table, or geography that is not carried in the column headers prefixed so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 260 + } + } + } + ] + }, + "model": "LivestockAndMeatDomesticData", + "openapi_extra": { + "model": "LivestockAndMeatDomesticData" + } + }, + "/usda/season_average_price_forecasts": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS season-average price forecasts - weekly ERS model and monthly WASDE marketing-year average price forecasts, with farm-bill PLC and ARC benchmarks, for corn, soybeans, wheat, and cotton.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.season_average_price_forecasts(provider='usda')\n# Get only the latest weekly forecast vintage for soybeans.\nobb.usda.season_average_price_forecasts(commodity='Soybeans', latest=True, provider='usda')\n# Get wheat season-average price forecasts since 2015.\nobb.usda.season_average_price_forecasts(commodity='Wheat', start_year=2015, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "commodity", + "type": "str | None", + "description": "Commodity to retrieve. Valid commodities are:\n Corn, Cotton, Soybeans, Wheat", + "default": "Corn", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity", + "value": "Corn", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Corn", + "value": "Corn" + }, + { + "label": "Cotton", + "value": "Cotton" + }, + { + "label": "Soybeans", + "value": "Soybeans" + }, + { + "label": "Wheat", + "value": "Wheat" + } + ], + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the marketing year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the marketing year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + }, + { + "name": "latest", + "type": "bool | None", + "description": "Return only the most recent weekly model forecast vintage. If False, every historical vintage is returned.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Latest vintage only" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SeasonAveragePriceForecasts", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "model_forecast_date", + "type": "str", + "description": "Weekly forecast vintage date the model was run, as published (YYYY-MM-DD).", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Forecast date", + "cellDataType": "date", + "pinned": "left", + "maxWidth": 130 + } + } + }, + { + "name": "marketing_year", + "type": "str", + "description": "Marketing year of the forecast, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Marketing year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 130 + } + } + }, + { + "name": "commodity", + "type": "str", + "description": "Commodity name, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "hide": true + } + } + }, + { + "name": "futures_model_type", + "type": "str", + "description": "Futures model type: 'Single contract' or 'Three contract aggregate'. Wheat publishes both on the same date.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Model type" + } + } + }, + { + "name": "futures_exchange", + "type": "str", + "description": "Futures exchange the model prices reference, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Exchange" + } + } + }, + { + "name": "mya_price_model_forecast", + "type": "float | None", + "description": "ERS model forecast of the marketing-year average price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "MYA price (model)", + "cellDataType": "number" + } + } + }, + { + "name": "mya_price_wasde_forecast", + "type": "float | None", + "description": "WASDE forecast of the marketing-year average price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "MYA price (WASDE)", + "cellDataType": "number" + } + } + }, + { + "name": "wasde_forecast_date", + "type": "str | None", + "description": "Date of the WASDE forecast, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "WASDE forecast date", + "cellDataType": "text" + } + } + }, + { + "name": "target_price", + "type": "float | None", + "description": "Farm-bill target price for the marketing year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Target price", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "national_loan_rate", + "type": "float | None", + "description": "Farm-bill national loan rate for the marketing year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "National loan rate", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "direct_payment_rate", + "type": "float | None", + "description": "Farm-bill direct payment rate for the marketing year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Direct payment rate", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "reference_price", + "type": "float | None", + "description": "Farm-bill statutory reference price for the marketing year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Reference price", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "ccp_effective_price_model_forecast", + "type": "float | None", + "description": "Counter-cyclical payment effective price, model forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "CCP effective price (model)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "ccp_rate_model_forecast", + "type": "float | None", + "description": "Counter-cyclical payment rate, model forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "CCP rate (model)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "ccp_effective_price_wasde_forecast", + "type": "float | None", + "description": "Counter-cyclical payment effective price, WASDE forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "CCP effective price (WASDE)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "ccp_rate_wasde_forecast", + "type": "float | None", + "description": "Counter-cyclical payment rate, WASDE forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "CCP rate (WASDE)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "historical_mya_price_year1", + "type": "float | None", + "description": "Marketing-year average price of the first historical year in the five-year benchmark window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA price yr 1", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "historical_mya_price_year2", + "type": "float | None", + "description": "Marketing-year average price of the second historical year in the five-year benchmark window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA price yr 2", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "historical_mya_price_year3", + "type": "float | None", + "description": "Marketing-year average price of the third historical year in the five-year benchmark window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA price yr 3", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "historical_mya_price_year4", + "type": "float | None", + "description": "Marketing-year average price of the fourth historical year in the five-year benchmark window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA price yr 4", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "historical_mya_price_year5", + "type": "float | None", + "description": "Marketing-year average price of the fifth historical year in the five-year benchmark window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA price yr 5", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "historical_mya_5year_range", + "type": "str | None", + "description": "Range of years spanned by the five-year benchmark window, as published, e.g. '2019-2023'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA 5-year range", + "hide": true + } + } + }, + { + "name": "historical_mya_price_5year_olympic_average", + "type": "float | None", + "description": "Olympic average of the five historical marketing-year average prices.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Historical MYA 5-year Olympic avg", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "effective_reference_price", + "type": "float | None", + "description": "Farm-bill effective reference price for the marketing year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective reference price", + "cellDataType": "number" + } + } + }, + { + "name": "effective_price_model_forecast", + "type": "float | None", + "description": "Price Loss Coverage effective price, model forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective price (model)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "plc_payment_rate_model_forecast", + "type": "float | None", + "description": "Price Loss Coverage payment rate, model forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "PLC payment rate (model)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "effective_price_wasde_forecast", + "type": "float | None", + "description": "Price Loss Coverage effective price, WASDE forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Effective price (WASDE)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "plc_payment_rate_wasde_forecast", + "type": "float | None", + "description": "Price Loss Coverage payment rate, WASDE forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "PLC payment rate (WASDE)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "maximum_plc_payment_rate", + "type": "float | None", + "description": "Maximum Price Loss Coverage payment rate for the year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Maximum PLC payment rate", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_annual_benchmark_price_year1", + "type": "float | None", + "description": "Agriculture Risk Coverage annual benchmark price of the first historical year in the window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC benchmark price yr 1", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_annual_benchmark_price_year2", + "type": "float | None", + "description": "Agriculture Risk Coverage annual benchmark price of the second historical year in the window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC benchmark price yr 2", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_annual_benchmark_price_year3", + "type": "float | None", + "description": "Agriculture Risk Coverage annual benchmark price of the third historical year in the window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC benchmark price yr 3", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_annual_benchmark_price_year4", + "type": "float | None", + "description": "Agriculture Risk Coverage annual benchmark price of the fourth historical year in the window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC benchmark price yr 4", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_annual_benchmark_price_year5", + "type": "float | None", + "description": "Agriculture Risk Coverage annual benchmark price of the fifth historical year in the window.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC benchmark price yr 5", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_annual_benchmark_price_5year_range", + "type": "str | None", + "description": "Range of years spanned by the ARC five-year benchmark window, as published, e.g. '2008-2012'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC benchmark 5-year range", + "hide": true + } + } + }, + { + "name": "arc_co_benchmark_price", + "type": "float | None", + "description": "Agriculture Risk Coverage county-option benchmark price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC-CO benchmark price", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_co_price_model_forecast", + "type": "float | None", + "description": "Agriculture Risk Coverage county-option price, model forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC-CO price (model)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_co_price_wasde_forecast", + "type": "float | None", + "description": "Agriculture Risk Coverage county-option price, WASDE forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC-CO price (WASDE)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_ic_price_model_forecast", + "type": "float | None", + "description": "Agriculture Risk Coverage individual-coverage price, model forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC-IC price (model)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "arc_ic_price_wasde_forecast", + "type": "float | None", + "description": "Agriculture Risk Coverage individual-coverage price, WASDE forecast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARC-IC price (WASDE)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "actual_mya_price", + "type": "float | None", + "description": "Actual realized marketing-year average price, once known.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Actual MYA price", + "cellDataType": "number" + } + } + }, + { + "name": "price_unit", + "type": "str", + "description": "Unit of the price columns, as published, e.g. 'U.S. dollars per bushel' or 'U.S. dollars per pound'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Price unit" + } + } + } + ] + }, + "model": "SeasonAveragePriceForecasts", + "openapi_extra": { + "model": "SeasonAveragePriceForecasts" + } + }, + "/usda/farm_income_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for a farm income and wealth table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key. Unknown tables fall back to the income statement's states.", + "default": "income_statement", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/farm_household_income_and_characteristics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Farm Household Income and Characteristics - income, finances, and characteristics of U.S. farm operator households, each pivoted to a wide layout by year or category.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.farm_household_income_and_characteristics(provider='usda')\n# Get mean and median U.S. farm operator household income since 2000.\nobb.usda.farm_household_income_and_characteristics(table='mean_median_income', start_year=2000, provider='usda')\n# Get 2024 household characteristics by age of the principal operator.\nobb.usda.farm_household_income_and_characteristics(table='by_age_2024', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. Each table is a set of line items pivoted to a wide layout: the item stays as the pinned row column while the time-series tables spread years into value columns and the cross-tab tables spread a category into value columns. Valid tables are:\n finances_2021_26f, mean_median_income, farm_size_class, by_farm_type_2024, by_occupation_2024, by_age_2024, by_experience_2024, by_management_team_2024, by_limited_resource_2024, by_sex_2024", + "default": "finances_2021_26f", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "finances_2021_26f", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Principal U.S. farm operator household finances, 2021-26F", + "value": "finances_2021_26f" + }, + { + "label": "Mean and median U.S. farm operator household income and ratio of farm household to U.S. household income, 1960-2024", + "value": "mean_median_income" + }, + { + "label": "All farms and family farms, by farm size class (gross sales), 1996-2024", + "value": "farm_size_class" + }, + { + "label": "Principal farm operator household finances, by farm type, 2024", + "value": "by_farm_type_2024" + }, + { + "label": "Finances and characteristics of principal farm operator households, by major occupation, 2024", + "value": "by_occupation_2024" + }, + { + "label": "Characteristics of principal farm operator households, by age of principal operators, 2024", + "value": "by_age_2024" + }, + { + "label": "Characteristics of principal farm operator households, by experience of operators, 2024", + "value": "by_experience_2024" + }, + { + "label": "Characteristics of principal farm operator households, by type of management team, 2024", + "value": "by_management_team_2024" + }, + { + "label": "Characteristics of principal farm operator households, by limited-resource farm status, 2024", + "value": "by_limited_resource_2024" + }, + { + "label": "Characteristics of principal farm operator households, by sex of principal operator, 2024", + "value": "by_sex_2024" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. Applies only to the time-series tables (farm_size_class, finances_2021_26f, mean_median_income). If None, returns from the first published year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. Applies only to the time-series tables. If None, returns up to the most recent year or forecast year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FarmHouseholdIncomeAndCharacteristics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "item", + "type": "str", + "description": "Published line item of the selected table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Item", + "pinned": "left", + "minWidth": 340 + } + } + } + ] + }, + "model": "FarmHouseholdIncomeAndCharacteristics", + "openapi_extra": { + "model": "FarmHouseholdIncomeAndCharacteristics" + } + }, + "/usda/farm_income_and_wealth_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS farm income and wealth statistics - U.S. and State-level farm sector income statements, production expenses, cash receipts, government payments, farm-related income, home consumption, inventory change, balance sheets, financial ratios, and farm business income, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.farm_income_and_wealth_statistics(provider='usda')\n# Get the Iowa farm income statement since 2015.\nobb.usda.farm_income_and_wealth_statistics(table='income_statement', state='IA', start_year=2015, provider='usda')\n# Get the U.S. farm sector balance sheet.\nobb.usda.farm_income_and_wealth_statistics(table='balance_sheet', provider='usda')\n# Get U.S. farm financial ratios since 2000.\nobb.usda.farm_income_and_wealth_statistics(table='financial_ratios', start_year=2000, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Statement to retrieve. Each table is a set of line items keyed by year; the years become the wide columns while the line item and its unit stay as pinned row columns. The balance sheet, financial ratios, and farm business income tables are published for the United States only. Valid tables are:\n income_statement, production_expenses, cash_receipts, government_payments, farm_related_income, home_consumption, inventory_change, balance_sheet, financial_ratios, farm_business_income", + "default": "income_statement", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "income_statement", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Income statement (value added)", + "value": "income_statement" + }, + { + "label": "Production expenses", + "value": "production_expenses" + }, + { + "label": "Cash receipts", + "value": "cash_receipts" + }, + { + "label": "Government payments", + "value": "government_payments" + }, + { + "label": "Farm-related income", + "value": "farm_related_income" + }, + { + "label": "Home consumption", + "value": "home_consumption" + }, + { + "label": "Inventory change", + "value": "inventory_change" + }, + { + "label": "Balance sheet (U.S.)", + "value": "balance_sheet" + }, + { + "label": "Financial ratios (U.S.)", + "value": "financial_ratios" + }, + { + "label": "Farm business income (U.S.)", + "value": "farm_business_income" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State to retrieve, as a two-letter code, or 'US' for the national aggregate. State detail is published for the income statement, production expenses, cash receipts, government payments, farm-related income, home consumption, and inventory change tables; the U.S.-only tables accept 'US'. Forecast years are published for 'US' only.", + "default": "US", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "value": "US", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/farm_income_states", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the first published year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent forecast year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FarmIncomeAndWealthStatistics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "line_item", + "type": "str", + "description": "Published line item of the statement, as the full variable description.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Line item", + "pinned": "left" + } + } + }, + { + "name": "unit", + "type": "str", + "description": "Unit of the line's values, as published, e.g. '$1,000', '$1,000 per farm', 'Ratio', 'Percent', or '1,000 acres'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "pinned": "left", + "maxWidth": 130 + } + } + }, + { + "name": "state", + "type": "str", + "description": "State of the observation, or 'United States' for the national aggregate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "hide": true + } + } + }, + { + "name": "part_1", + "type": "str | None", + "description": "First component of the line-item description, as published, when the item is broken out.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Component", + "hide": true + } + } + }, + { + "name": "part_2", + "type": "str | None", + "description": "Second component of the line-item description, as published, when the item is broken out.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Subcomponent", + "hide": true + } + } + } + ] + }, + "model": "FarmIncomeAndWealthStatistics", + "openapi_extra": { + "model": "FarmIncomeAndWealthStatistics" + } + }, + "/usda/food_dollar_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS food dollar series - the marketing-bill breakdown of the U.S. food dollar into industry groups and primary factors, in nominal and real terms, each table pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_dollar_series(provider='usda')\n# Get the real (2017-dollar) food dollar in millions of dollars.\nobb.usda.food_dollar_series(series='real', units='level', table=1, provider='usda')\n# Get the beef, pork, and other meats commodity-group breakdown.\nobb.usda.food_dollar_series(table=9, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "series", + "type": "str | None", + "description": "Series to retrieve, selecting the source dataset. 'nominal' is current-year dollars with the full primary-factor decomposition and all 22 tables; 'real' is inflation-adjusted 2017 dollars with only the six food-dollar aggregate tables.", + "default": "nominal", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Series", + "multiSelect": false, + "multiple": false, + "value": "nominal", + "options": [ + { + "label": "Nominal (current dollars)", + "value": "nominal" + }, + { + "label": "Real (2017 dollars)", + "value": "real" + } + ] + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "Units of the cell values. 'share' is cents per domestic food dollar; 'level' is millions of dollars. Orthogonal to series.", + "default": "share", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Units", + "multiSelect": false, + "multiple": false, + "value": "share", + "options": [ + { + "label": "Share (cents per food dollar)", + "value": "share" + }, + { + "label": "Level (million dollars)", + "value": "level" + } + ] + } + } + }, + { + "name": "component", + "type": "str | None", + "description": "Primary-factor component that fills the cells. Valid components depend on series; for nominal:\n total, salary_and_benefits, property_income, output_taxes, imports\nfor real:\n total, value_added, imports\n'total' is populated for every year and category.", + "default": "total", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Primary factor", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": "total", + "optionsEndpoint": "/api/v1/usda/food_dollar_components", + "optionsParams": { + "series": "$series" + }, + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "table", + "type": "int | None", + "description": "Food-dollar table to retrieve, by table number. Nominal offers tables 1-22 (six dollar aggregates and 16 commodity groups); real offers only tables 1-6.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": 1, + "optionsEndpoint": "/api/v1/usda/food_dollar_tables", + "optionsParams": { + "series": "$series" + }, + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the series' first year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodDollarSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "industry_group", + "type": "str", + "description": "Marketing-bill industry group or aggregate, as published, e.g. 'Farm production', 'Foodservices', or 'Farm share'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Industry group", + "pinned": "left" + } + } + } + ] + }, + "model": "FoodDollarSeries", + "openapi_extra": { + "model": "FoodDollarSeries" + } + }, + "/usda/food_dollar_components": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the primary-factor components available for a food-dollar series.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "series", + "type": "str", + "description": "Series key, nominal or real. Unknown series fall back to nominal.", + "default": "nominal", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/food_dollar_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the food-dollar tables available for a series.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "series", + "type": "str", + "description": "Series key, nominal or real. Unknown series fall back to nominal.", + "default": "nominal", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/food_expenditure_series": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Food Expenditure Series - U.S. food and alcohol expenditures by outlet, final purchaser, month, and state, in nominal and constant dollars, each pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_expenditure_series(provider='usda')\n# Get constant-dollar food and alcohol expenditures since 2015.\nobb.usda.food_expenditure_series(measure='constant', start_year=2015, provider='usda')\n# Get monthly food sales.\nobb.usda.food_expenditure_series(table='monthly', provider='usda')\n# Get food expenditures by final purchaser since 2010.\nobb.usda.food_expenditure_series(table='by_final_purchaser', start_year=2010, provider='usda')\n# Get California per-capita food sales without taxes and tips.\nobb.usda.food_expenditure_series(table='state_per_capita', state='california', taxes='without', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Food Expenditure Series table to retrieve. Each table's category series become the wide value columns while the year, folded with the month or state where either varies, forms the pinned period label. Valid tables are:\n food_and_alcohol, by_final_purchaser, normalized, monthly, monthly_by_outlet, state, state_per_capita", + "default": "food_and_alcohol", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "food_and_alcohol", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Food and alcohol expenditures, by all purchasers", + "value": "food_and_alcohol" + }, + { + "label": "Food expenditures, by final purchaser", + "value": "by_final_purchaser" + }, + { + "label": "Normalized food expenditures and income shares", + "value": "normalized" + }, + { + "label": "Monthly food sales", + "value": "monthly" + }, + { + "label": "Monthly food sales, by outlet type", + "value": "monthly_by_outlet" + }, + { + "label": "State food sales", + "value": "state" + }, + { + "label": "State food sales, per capita", + "value": "state_per_capita" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Dollar measure. 'nominal' returns current-dollar values; 'constant' returns chained 2025-dollar values. Selects the source file for the food_and_alcohol, state, and state_per_capita tables and the value columns for the others. Ignored by the percentage share columns of the normalized table.", + "default": "nominal", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "value": "nominal", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Nominal dollars", + "value": "nominal" + }, + { + "label": "Constant dollars (2025=100)", + "value": "constant" + } + ] + } + } + }, + { + "name": "taxes", + "type": "str | None", + "description": "Sales-tax and tip treatment. 'with' includes taxes and tips; 'without' excludes them. Selects the source file for the food_and_alcohol, state, and state_per_capita tables; the other tables publish a single treatment and ignore this.", + "default": "with", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Taxes and tips", + "value": "with", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "With taxes and tips", + "value": "with" + }, + { + "label": "Without taxes and tips", + "value": "without" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Filter the state and state_per_capita tables to states matching this case-insensitive substring, e.g. 'california'. If None, every state is returned. Ignored by the other tables.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Alabama", + "value": "Alabama" + }, + { + "label": "Alaska", + "value": "Alaska" + }, + { + "label": "Arizona", + "value": "Arizona" + }, + { + "label": "Arkansas", + "value": "Arkansas" + }, + { + "label": "California", + "value": "California" + }, + { + "label": "Colorado", + "value": "Colorado" + }, + { + "label": "Connecticut", + "value": "Connecticut" + }, + { + "label": "Delaware", + "value": "Delaware" + }, + { + "label": "District of Columbia", + "value": "District of Columbia" + }, + { + "label": "Florida", + "value": "Florida" + }, + { + "label": "Georgia", + "value": "Georgia" + }, + { + "label": "Hawaii", + "value": "Hawaii" + }, + { + "label": "Idaho", + "value": "Idaho" + }, + { + "label": "Illinois", + "value": "Illinois" + }, + { + "label": "Indiana", + "value": "Indiana" + }, + { + "label": "Iowa", + "value": "Iowa" + }, + { + "label": "Kansas", + "value": "Kansas" + }, + { + "label": "Kentucky", + "value": "Kentucky" + }, + { + "label": "Louisiana", + "value": "Louisiana" + }, + { + "label": "Maine", + "value": "Maine" + }, + { + "label": "Maryland", + "value": "Maryland" + }, + { + "label": "Massachusetts", + "value": "Massachusetts" + }, + { + "label": "Michigan", + "value": "Michigan" + }, + { + "label": "Minnesota", + "value": "Minnesota" + }, + { + "label": "Mississippi", + "value": "Mississippi" + }, + { + "label": "Missouri", + "value": "Missouri" + }, + { + "label": "Montana", + "value": "Montana" + }, + { + "label": "Nebraska", + "value": "Nebraska" + }, + { + "label": "Nevada", + "value": "Nevada" + }, + { + "label": "New Hampshire", + "value": "New Hampshire" + }, + { + "label": "New Jersey", + "value": "New Jersey" + }, + { + "label": "New Mexico", + "value": "New Mexico" + }, + { + "label": "New York", + "value": "New York" + }, + { + "label": "North Carolina", + "value": "North Carolina" + }, + { + "label": "North Dakota", + "value": "North Dakota" + }, + { + "label": "Ohio", + "value": "Ohio" + }, + { + "label": "Oklahoma", + "value": "Oklahoma" + }, + { + "label": "Oregon", + "value": "Oregon" + }, + { + "label": "Pennsylvania", + "value": "Pennsylvania" + }, + { + "label": "Rhode Island", + "value": "Rhode Island" + }, + { + "label": "South Carolina", + "value": "South Carolina" + }, + { + "label": "South Dakota", + "value": "South Dakota" + }, + { + "label": "Tennessee", + "value": "Tennessee" + }, + { + "label": "Texas", + "value": "Texas" + }, + { + "label": "Utah", + "value": "Utah" + }, + { + "label": "Vermont", + "value": "Vermont" + }, + { + "label": "Virginia", + "value": "Virginia" + }, + { + "label": "Washington", + "value": "Washington" + }, + { + "label": "West Virginia", + "value": "West Virginia" + }, + { + "label": "Wisconsin", + "value": "Wisconsin" + }, + { + "label": "Wyoming", + "value": "Wyoming" + } + ], + "style": { + "popupWidth": 260 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodExpenditureSeries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual tables ('2020'), the year and month for monthly tables ('2020 March'), with the state prefixed when more than one state is shown at once ('California \u2014 2020'), so each row is uniquely labeled.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 280 + } + } + } + ] + }, + "model": "FoodExpenditureSeries", + "openapi_extra": { + "model": "FoodExpenditureSeries" + } + }, + "/usda/us_food_imports": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS U.S. food imports - annual value, volume, unit prices, and price inflation by food group and by source country.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.us_food_imports(provider='usda')\n# Get U.S. food import volume by food group since 2015.\nobb.usda.us_food_imports(table='by_food_group', measure='volume', start_year=2015, provider='usda')\n# Get fresh fruit imports by source country.\nobb.usda.us_food_imports(table='by_source', food_group='Fruits', commodity='Fresh or chilled fruit', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. 'by_food_group' spreads the 14 food groups and a total-foods column across the years; 'by_source' spreads the source countries of the selected food group and product line across the years. Valid tables are:\n by_food_group, by_source", + "default": "by_food_group", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "by_food_group", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "By food group", + "value": "by_food_group" + }, + { + "label": "By source country", + "value": "by_source" + } + ] + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Measure to spread into the wide columns. 'by_source' supports only 'value' and 'volume'. Valid measures are:\n value, value_change, volume, volume_change, unit_price, inflation", + "default": "value", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "value": "value", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Value (million $)", + "value": "value" + }, + { + "label": "Volume", + "value": "volume" + }, + { + "label": "Value, year-over-year change (%)", + "value": "value_change" + }, + { + "label": "Volume, year-over-year change (%)", + "value": "volume_change" + }, + { + "label": "Unit price", + "value": "unit_price" + }, + { + "label": "Price inflation (%)", + "value": "inflation" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "food_group", + "type": "str | None", + "description": "Food group whose source countries are spread into columns for the 'by_source' table. Ignored by the 'by_food_group' table. Valid food groups are:\n Animals, Meats, Fish, Dairy, Vegetables, Fruits, Nuts, Coffee, Grains, VegetablesOil, Sweets, Cocoa, Other, Beverages", + "default": "Fruits", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Food group (source table)", + "value": "Fruits", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Live animals", + "value": "Animals" + }, + { + "label": "Meats", + "value": "Meats" + }, + { + "label": "Fish and shellfish", + "value": "Fish" + }, + { + "label": "Dairy", + "value": "Dairy" + }, + { + "label": "Vegetables", + "value": "Vegetables" + }, + { + "label": "Fruits", + "value": "Fruits" + }, + { + "label": "Nuts", + "value": "Nuts" + }, + { + "label": "Coffee, tea, and spices", + "value": "Coffee" + }, + { + "label": "Grains", + "value": "Grains" + }, + { + "label": "Vegetable oils", + "value": "VegetablesOil" + }, + { + "label": "Sugar and candy", + "value": "Sweets" + }, + { + "label": "Cocoa and chocolate", + "value": "Cocoa" + }, + { + "label": "Other edible products", + "value": "Other" + }, + { + "label": "Beverages", + "value": "Beverages" + } + ], + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Product line within the selected food group for the 'by_source' table, e.g. 'Fresh or chilled fruit'. If None, the food group's total line is used. Ignored by the 'by_food_group' table.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity (source table)", + "type": "endpoint", + "value": "Total fruit and preparations", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/food_import_commodities", + "optionsParams": { + "food_group": "$food_group" + }, + "style": { + "popupWidth": 380 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from 1999, the first year of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsFoodImports", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Calendar year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "number", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "food_group", + "type": "str | None", + "description": "Food group of the source-country table. None for the by-food-group table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food group", + "hide": true + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Product line of the source-country table, as published. None for the by-food-group table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "hide": true + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit shared by every value column, when uniform; None when the unit varies by column and is carried in each column header instead.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + } + ] + }, + "model": "UsFoodImports", + "openapi_extra": { + "model": "UsFoodImports" + } + }, + "/usda/food_import_commodities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the product lines available for a food group's source-country table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "food_group", + "type": "str", + "description": "Detail food-group category code, e.g. 'Fruits'.", + "default": "Fruits", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/us_bioenergy_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS U.S. Bioenergy Statistics - ethanol, biodiesel, and renewable diesel supply, use, capacity, consumption, and prices, each pivoted to a wide layout by period.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.us_bioenergy_statistics(provider='usda')\n# Get fuel ethanol supply and disappearance by calendar year since 2015.\nobb.usda.us_bioenergy_statistics(table='ethanol_supply_calendar_year', start_year=2015, provider='usda')\n# Get fuel ethanol production capacity by State.\nobb.usda.us_bioenergy_statistics(table='ethanol_capacity_by_state', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Bioenergy-statistics table to retrieve. Each table is a set of named supply, use, capacity, or price series indexed by year and period; the series become the wide value columns while a single period column, with any varying location folded in, stays as the pinned row column. Valid tables are:\n ethanol_supply_marketing_year, ethanol_supply_calendar_year, ethanol_supply_monthly, biodiesel_supply_marketing_year, biodiesel_supply_calendar_year, renewable_diesel_supply_marketing_year, renewable_diesel_supply_calendar_year, corn_supply_and_ethanol_share, soybean_oil_supply_and_biofuel_share, oils_and_fats_supply_and_prices, distillers_grains_supply, corn_gluten_meal_supply, corn_gluten_feed_supply, distillers_dried_grains_price, ethanol_capacity_and_utilization, ethanol_capacity_by_state, biodiesel_renewable_diesel_plants_by_state, alternative_fuel_stations, corn_ethanol_gasoline_prices_monthly, ethanol_gasoline_consumption_and_share, biodiesel_and_diesel_prices, retail_diesel_prices_monthly", + "default": "ethanol_supply_marketing_year", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "ethanol_supply_marketing_year", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Fuel ethanol supply and disappearance and grain crushings for fuel ethanol by marketing year and quarter", + "value": "ethanol_supply_marketing_year" + }, + { + "label": "Fuel ethanol supply and disappearance and grain crushings for fuel ethanol by calendar year", + "value": "ethanol_supply_calendar_year" + }, + { + "label": "Fuel ethanol supply and disappearance and grain crushings for fuel ethanol by month", + "value": "ethanol_supply_monthly" + }, + { + "label": "Biodiesel supply and disappearance by soybean oil marketing year", + "value": "biodiesel_supply_marketing_year" + }, + { + "label": "Biodiesel supply and disappearance by calendar year", + "value": "biodiesel_supply_calendar_year" + }, + { + "label": "Renewable diesel supply and disappearance by soybean oil marketing year", + "value": "renewable_diesel_supply_marketing_year" + }, + { + "label": "Renewable diesel supply and disappearance by calendar year", + "value": "renewable_diesel_supply_calendar_year" + }, + { + "label": "Corn supply, disappearance, and share of total corn used for ethanol", + "value": "corn_supply_and_ethanol_share" + }, + { + "label": "Soybean oil supply, disappearance, and share used for biofuel", + "value": "soybean_oil_supply_and_biofuel_share" + }, + { + "label": "Oils and fats supply and prices", + "value": "oils_and_fats_supply_and_prices" + }, + { + "label": "Distillers grains supply and disappearance", + "value": "distillers_grains_supply" + }, + { + "label": "Corn gluten meal supply and disappearance", + "value": "corn_gluten_meal_supply" + }, + { + "label": "Corn gluten feed supply and disappearance", + "value": "corn_gluten_feed_supply" + }, + { + "label": "Distillers dried grains price", + "value": "distillers_dried_grains_price" + }, + { + "label": "Fuel ethanol production facilities capacity, production, and utilization ratios", + "value": "ethanol_capacity_and_utilization" + }, + { + "label": "Fuel ethanol production facilities capacity, by State", + "value": "ethanol_capacity_by_state" + }, + { + "label": "Biodiesel and renewable diesel production: Number of plants and capacity by State", + "value": "biodiesel_renewable_diesel_plants_by_state" + }, + { + "label": "Alternative fuel stations", + "value": "alternative_fuel_stations" + }, + { + "label": "Monthly prices for corn, fuel ethanol, and gasoline", + "value": "corn_ethanol_gasoline_prices_monthly" + }, + { + "label": "Fuel ethanol and finished motor gasoline consumption and fuel ethanol market share", + "value": "ethanol_gasoline_consumption_and_share" + }, + { + "label": "Biodiesel and diesel prices", + "value": "biodiesel_and_diesel_prices" + }, + { + "label": "Monthly average retail diesel prices", + "value": "retail_diesel_prices_monthly" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsBioenergyStatistics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual tables ('2020'), the year and month or quarter for sub-annual tables ('2020 Jan', '2020 Q1 Sep-Nov'), with any varying State or market city folded in so each row is uniquely labeled ('Texas \u2014 2025').", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 240 + } + } + } + ] + }, + "model": "UsBioenergyStatistics", + "openapi_extra": { + "model": "UsBioenergyStatistics" + } + }, + "/usda/agricultural_exchange_rates": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS agricultural exchange rates - real and nominal commodity trade-weighted exchange rate indexes and bilateral local-currency-per-USD rates, each pivoted to a wide layout with time in the rows and the commodity (index tables) or partner country (bilateral tables) in the columns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.agricultural_exchange_rates(provider='usda')\n# Get real bilateral exchange rates for North American partner countries.\nobb.usda.agricultural_exchange_rates(provider='usda', table='real_bilateral_annual', region='North America')\n# Get the monthly U.S.-import-weighted real trade-weighted index since 2020.\nobb.usda.agricultural_exchange_rates(provider='usda', table='real_index_monthly', weights='U.S. suppliers (U.S. import weights)', start_year=2020)\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Exchange-rate table to retrieve. Each table pivots to a wide layout with time in the rows and the commodity (index tables) or partner country (bilateral tables) in the value columns. Valid tables are:\n real_index_annual, real_index_monthly, real_bilateral_annual, real_bilateral_monthly, nominal_bilateral_annual, nominal_bilateral_monthly", + "default": "real_index_annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "real_index_annual", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Real trade-weighted index (annual)", + "value": "real_index_annual" + }, + { + "label": "Real trade-weighted index (monthly)", + "value": "real_index_monthly" + }, + { + "label": "Real bilateral rate, local currency per USD (annual)", + "value": "real_bilateral_annual" + }, + { + "label": "Real bilateral rate, local currency per USD (monthly)", + "value": "real_bilateral_monthly" + }, + { + "label": "Nominal bilateral rate, local currency per USD (annual)", + "value": "nominal_bilateral_annual" + }, + { + "label": "Nominal bilateral rate, local currency per USD (monthly)", + "value": "nominal_bilateral_monthly" + } + ], + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "weights", + "type": "str | None", + "description": "Trade-weight scheme to keep for the index tables. Defaults to the U.S. export-weighted index. Set to None to stack all three schemes as a pinned row dimension. Ignored for the bilateral tables. Valid schemes are:\n U.S. competitors (country export weights), U.S. markets (U.S. export weights), U.S. suppliers (U.S. import weights)", + "default": "U.S. markets (U.S. export weights)", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Weight scheme", + "value": "U.S. markets (U.S. export weights)", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "U.S. competitors (country export weights)", + "value": "U.S. competitors (country export weights)" + }, + { + "label": "U.S. markets (U.S. export weights)", + "value": "U.S. markets (U.S. export weights)" + }, + { + "label": "U.S. suppliers (U.S. import weights)", + "value": "U.S. suppliers (U.S. import weights)" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "Region to keep for the bilateral tables, filtering which partner-country columns appear. If None, all partner countries are returned. Ignored for the index tables. Valid regions are:\n Central America, Europe, Middle East, North Africa, North America, Northeast Asia, Oceania, South America, South Asia, Southeast Asia, Sub-Saharan Africa, The Caribbean", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Region", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Central America", + "value": "Central America" + }, + { + "label": "Europe", + "value": "Europe" + }, + { + "label": "Middle East", + "value": "Middle East" + }, + { + "label": "North Africa", + "value": "North Africa" + }, + { + "label": "North America", + "value": "North America" + }, + { + "label": "Northeast Asia", + "value": "Northeast Asia" + }, + { + "label": "Oceania", + "value": "Oceania" + }, + { + "label": "South America", + "value": "South America" + }, + { + "label": "South Asia", + "value": "South Asia" + }, + { + "label": "Southeast Asia", + "value": "Southeast Asia" + }, + { + "label": "Sub-Saharan Africa", + "value": "Sub-Saharan Africa" + }, + { + "label": "The Caribbean", + "value": "The Caribbean" + } + ], + "style": { + "popupWidth": 260 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AgriculturalExchangeRates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the year for annual tables ('1970'), the year and month for monthly tables ('1970 January'), with the trade-weight scheme prefixed when more than one scheme is shown at once.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 320 + } + } + } + ] + }, + "model": "AgriculturalExchangeRates", + "openapi_extra": { + "model": "AgriculturalExchangeRates" + } + }, + "/usda/agricultural_productivity_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for an agricultural productivity table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key. Unknown tables fall back to the national table's states.", + "default": "national_indices", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/agricultural_productivity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS agricultural productivity - the farm output, input, and total factor productivity indices for the United States and the relative productivity levels of the 48 contiguous States, each pivoted to a wide layout with the series as columns and years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.agricultural_productivity(provider='usda')\n# Get the U.S. farm output, input, and TFP indices since 2000.\nobb.usda.agricultural_productivity(table='national_indices', start_year=2000, provider='usda')\n# Get California's relative TFP, output, and input levels.\nobb.usda.agricultural_productivity(table='state_relative_levels', state='CA', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Productivity table to retrieve. Each table is a set of named index series indexed by year; the series become the wide value columns while year, and the State for the relative-levels table, stay as pinned row columns. The national tables cover the United States; the relative-levels table covers the 48 contiguous States. Valid tables are:\n national_indices, national_price_quantity, state_relative_levels", + "default": "national_indices", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "national_indices", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 1. Farm output, input, and TFP indices (U.S., 1948-2021)", + "value": "national_indices" + }, + { + "label": "Table 1a. Price indices and implicit quantities (U.S., 1948-2021)", + "value": "national_price_quantity" + }, + { + "label": "Table 2. Relative levels of TFP, output & input indices (48 States, 1960-2015)", + "value": "state_relative_levels" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State to retrieve for the relative-levels table, as a two-letter code, or 'US' for the national tables. The national tables are published for the United States only; a State value is ignored for them.", + "default": "US", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "value": "US", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/agricultural_productivity_states", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AgriculturalProductivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State of the observation, or 'United States' for the national tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "pinned": "left", + "hide": true + } + } + } + ] + }, + "model": "AgriculturalProductivity", + "openapi_extra": { + "model": "AgriculturalProductivity" + } + }, + "/usda/ag_productivity_countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the countries, territories, and aggregates in a grouping.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "grouping", + "type": "str", + "description": "Grouping key. Unknown groupings fall back to the country grouping.", + "default": "country_grouping", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/international_agricultural_productivity": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS international agricultural productivity - agricultural total factor productivity indices, output and input quantity indices, and the underlying physical output and input quantities for countries, territories, regions, income groups, and the world, pivoted to a wide layout by year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.international_agricultural_productivity(provider='usda')\n# Get U.S. agricultural productivity indices since 2000.\nobb.usda.international_agricultural_productivity(grouping='north_america', country=179, start_year=2000, provider='usda')\n# Get India's physical output and input quantities.\nobb.usda.international_agricultural_productivity(grouping='asia_pacific', country=103, measure='physical_quantities', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "grouping", + "type": "str | None", + "description": "Grouping that scopes the country selector into buckets derived from the entity's region, income level, or aggregate type. It scopes the dropdown only; the data is selected by country. Valid groupings are:\n sub_saharan_africa, latin_america_caribbean, asia_pacific, cwana, europe, oceania, north_america, income_group, country_grouping", + "default": "country_grouping", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Grouping", + "value": "country_grouping", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Sub-Saharan Africa", + "value": "sub_saharan_africa" + }, + { + "label": "Latin America & Caribbean", + "value": "latin_america_caribbean" + }, + { + "label": "Asia & Pacific", + "value": "asia_pacific" + }, + { + "label": "Central/West Asia & North Africa", + "value": "cwana" + }, + { + "label": "Europe", + "value": "europe" + }, + { + "label": "Oceania", + "value": "oceania" + }, + { + "label": "North America", + "value": "north_america" + }, + { + "label": "Income group", + "value": "income_group" + }, + { + "label": "Country grouping", + "value": "country_grouping" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "country", + "type": "int | None", + "description": "Country, territory, region, income group, or aggregate to retrieve, as its unique dataset order. The order disambiguates entities sharing a name, e.g. the country 'China' (81) from the income aggregate 'China' (227). Defaults to 220, the world.", + "default": 220, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Country / territory", + "type": "endpoint", + "value": 220, + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/ag_productivity_countries", + "optionsParams": { + "grouping": "$grouping" + }, + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Measure family spread into the wide value columns. 'productivity_indices' emits the seven 2015=100 indices; 'physical_quantities' emits the twelve output and input quantities in their published units. Valid measures are:\n productivity_indices, physical_quantities", + "default": "productivity_indices", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "value": "productivity_indices", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Productivity indices (2015=100)", + "value": "productivity_indices" + }, + { + "label": "Physical quantities", + "value": "physical_quantities" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, from 1961. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, up to 2023. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "InternationalAgriculturalProductivity", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + } + ] + }, + "model": "InternationalAgriculturalProductivity", + "openapi_extra": { + "model": "InternationalAgriculturalProductivity" + } + }, + "/usda/international_macroeconomic_data_set": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS International Macroeconomic Data Set - historical and projected real GDP, GDP per capita, GDP deflator, real GDP shares, real exchange rates, consumer price indices, and population for baseline countries and regions from 1970 through the 2035 projection horizon, pivoted to a wide layout with the countries and regions as columns and the years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.international_macroeconomic_data_set(provider='usda')\n# Get real GDP year-to-year growth rates by country and region since 2000.\nobb.usda.international_macroeconomic_data_set(variable='real_gdp', measure='growth', start_year=2000, provider='usda')\n# Get historical and projected population by country and region.\nobb.usda.international_macroeconomic_data_set(variable='population', measure='level', provider='usda')\n# Get consumer price indices, 2017 = 100, since 2010.\nobb.usda.international_macroeconomic_data_set(variable='cpi', measure='level', start_year=2010, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "variable", + "type": "str | None", + "description": "Macroeconomic variable to retrieve. Each variable is a separate file whose baseline countries and regions spread into the wide columns while the years stay in the rows, running from 1970 through the 2035 projection horizon. Valid variables are:\n real_gdp, real_gdp_per_capita, gdp_deflator, real_gdp_shares, real_exchange_rate, cpi, population", + "default": "real_gdp", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Variable", + "value": "real_gdp", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Real GDP (billions of 2017 dollars)", + "value": "real_gdp" + }, + { + "label": "Real GDP per capita (2017 dollars)", + "value": "real_gdp_per_capita" + }, + { + "label": "GDP deflator (2017 = 100)", + "value": "gdp_deflator" + }, + { + "label": "Real GDP shares (share of world GDP)", + "value": "real_gdp_shares" + }, + { + "label": "Real exchange rate (2017 = 100)", + "value": "real_exchange_rate" + }, + { + "label": "Consumer price index (2017 = 100)", + "value": "cpi" + }, + { + "label": "Population", + "value": "population" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Measure to spread. 'level' returns the variable's level unit; 'growth' returns its year-to-year percent change. Valid measures are:\n level, growth", + "default": "level", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "value": "level", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Level", + "value": "level" + }, + { + "label": "Percent change, year to year", + "value": "growth" + } + ], + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from 1970, the first year of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns through 2035, the last projection year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "InternationalMacroeconomicDataSet", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Calendar year of the observation, from 1970 through the 2035 projection horizon.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "number", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit shared by every value column for the selected variable and measure, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + } + ] + }, + "model": "InternationalMacroeconomicDataSet", + "openapi_extra": { + "model": "InternationalMacroeconomicDataSet" + } + }, + "/usda/livestock_trade_products": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the product blocks published for a species and trade direction.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Species key. Unknown species fall back to beef and veal.", + "default": "beef_veal", + "optional": true + }, + { + "name": "direction", + "type": "str", + "description": "'imports' or 'exports'. Unknown directions fall back to imports.", + "default": "imports", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/livestock_and_meat_international_trade_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS livestock and meat international trade data - U.S. import and export trade in live cattle, hogs, sheep, and goats and in beef and veal, pork, lamb and mutton, poultry meat, and eggs, by trading partner, each pivoted to a wide layout with years as columns and the two cumulative year-to-date columns trailing.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.livestock_and_meat_international_trade_data(provider='usda')\n# Get U.S. beef and veal exports by partner since 2015.\nobb.usda.livestock_and_meat_international_trade_data(table='beef_veal', direction='exports', start_year=2015, provider='usda')\n# Get monthly U.S. pork imports by partner.\nobb.usda.livestock_and_meat_international_trade_data(table='pork', direction='imports', frequency='monthly', provider='usda')\n# Get U.S. shell-egg exports by partner.\nobb.usda.livestock_and_meat_international_trade_data(table='poultry_eggs', direction='exports', product='Shell-egg', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Species workbook to retrieve. Each species publishes import and export blocks by trading partner and time; the years become the wide columns while the country stays as a pinned row. Valid species are:\n beef_veal, cattle, pork, hogs, lamb_mutton, sheep_goats, poultry_eggs", + "default": "beef_veal", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Species", + "value": "beef_veal", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Beef and veal", + "value": "beef_veal" + }, + { + "label": "Cattle", + "value": "cattle" + }, + { + "label": "Pork", + "value": "pork" + }, + { + "label": "Hogs", + "value": "hogs" + }, + { + "label": "Lamb and mutton", + "value": "lamb_mutton" + }, + { + "label": "Sheep and goats", + "value": "sheep_goats" + }, + { + "label": "Chickens, turkeys, and eggs", + "value": "poultry_eggs" + } + ], + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "direction", + "type": "str | None", + "description": "Trade direction to retrieve. Valid directions are:\n imports, exports", + "default": "imports", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Direction", + "value": "imports", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Imports", + "value": "imports" + }, + { + "label": "Exports", + "value": "exports" + } + ] + } + } + }, + { + "name": "frequency", + "type": "str | None", + "description": "Reporting frequency. 'annual' spreads calendar years plus the two cumulative year-to-date columns; 'monthly' keeps the year columns and adds a month row dimension. Valid frequencies are:\n annual, monthly", + "default": "annual", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Frequency", + "value": "annual", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Annual", + "value": "annual" + }, + { + "label": "Monthly", + "value": "monthly" + } + ] + } + } + }, + { + "name": "product", + "type": "str | None", + "description": "Product block within the selected species and direction, e.g. 'Cattle, cattle for breeding' or 'Shell-egg'. If None, the direction's first published block is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Product", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/livestock_trade_products", + "optionsParams": { + "table": "$table", + "direction": "$direction" + }, + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from 1989, the first year of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year-to-date column.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "LivestockAndMeatInternationalTradeData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "country", + "type": "str", + "description": "Trading-partner geography, as published, including the 'Other geographies' residual. On the monthly frequency the month is appended so each partner-month row is labeled, e.g. 'Canada \u2014 Jan', and the year columns hold that month's value across years.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Country", + "pinned": "left" + } + } + }, + { + "name": "month", + "type": "str | None", + "description": "Month of the observation for the monthly frequency, as a three-letter abbreviation. None for the annual frequency.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Month", + "pinned": "left", + "hide": true + } + } + }, + { + "name": "geography_code", + "type": "int | None", + "description": "U.S. Census Bureau geography code of the trading partner. None for the 'Other geographies' residual.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Geography code", + "cellDataType": "number", + "hide": true, + "maxWidth": 130 + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit shared by every value column of the selected block, e.g. 'Carcass weight, 1,000 pounds', 'Head', or '1,000 dozen'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + } + ] + }, + "model": "LivestockAndMeatInternationalTradeData", + "openapi_extra": { + "model": "LivestockAndMeatInternationalTradeData" + } + }, + "/usda/state_ag_trade_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for a state agricultural trade table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key. Unknown tables fall back to the calendar-year states.", + "default": "exports_by_commodity", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/state_agricultural_trade": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS state agricultural trade - state-level U.S. agricultural exports by commodity and by state on a calendar-year basis, and the top export and import commodities by state on a fiscal-year basis, each pivoted to a wide layout with the years in the rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.state_agricultural_trade(provider='usda')\n# Get California's agricultural exports by commodity.\nobb.usda.state_agricultural_trade(table='exports_by_commodity', state='California', provider='usda')\n# Get total agricultural exports spread across the states.\nobb.usda.state_agricultural_trade(table='exports_by_state', commodity='Total agricultural exports', provider='usda')\n# Get Texas's top export commodities by fiscal year.\nobb.usda.state_agricultural_trade(table='top_exports', state='Texas', provider='usda')\n# Get California's top import commodities by fiscal year.\nobb.usda.state_agricultural_trade(table='top_imports', state='California', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. 'exports_by_commodity' spreads a state's export commodities across the calendar years; 'exports_by_state' spreads the states across the calendar years for one commodity; 'top_exports' and 'top_imports' spread a state's top fiscal-year commodities across the fiscal years. Valid tables are:\n exports_by_commodity, exports_by_state, top_exports, top_imports", + "default": "exports_by_commodity", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "exports_by_commodity", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Exports by commodity (state, calendar year)", + "value": "exports_by_commodity" + }, + { + "label": "Exports by state (commodity, calendar year)", + "value": "exports_by_state" + }, + { + "label": "Top export commodities (state, fiscal year)", + "value": "top_exports" + }, + { + "label": "Top import commodities (state, fiscal year)", + "value": "top_imports" + } + ], + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State whose commodities are spread into columns for the 'exports_by_commodity', 'top_exports', and 'top_imports' tables, as a full state name or two-letter code, or 'United States' for the national total. Ignored by the 'exports_by_state' table. The calendar-year tables cover the 50 states and the United States; the fiscal-year tables also cover the District of Columbia, Puerto Rico, and the Virgin Islands.", + "default": "California", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "value": "California", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/state_ag_trade_states", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity whose states are spread into columns for the 'exports_by_state' table. Ignored by the other tables. Valid commodities are:\n Total agricultural exports, Total animal products, Total plant products, Beef and veal, Broiler meat, Corn, Cotton, Dairy products, Feeds and other feed grains, Fruits, fresh, Fruits, processed, Grain products, Hides and skins, Other livestock products, Other oilseeds and products, Other plant products, Other poultry products, Pork, Rice, Soybean meal, Soybeans, Tobacco, Tree nuts, Vegetable oils, Vegetables, fresh, Vegetables, processed, Wheat", + "default": "Total agricultural exports", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity (exports by state)", + "value": "Total agricultural exports", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Total agricultural exports", + "value": "Total agricultural exports" + }, + { + "label": "Total animal products", + "value": "Total animal products" + }, + { + "label": "Total plant products", + "value": "Total plant products" + }, + { + "label": "Beef and veal", + "value": "Beef and veal" + }, + { + "label": "Broiler meat", + "value": "Broiler meat" + }, + { + "label": "Corn", + "value": "Corn" + }, + { + "label": "Cotton", + "value": "Cotton" + }, + { + "label": "Dairy products", + "value": "Dairy products" + }, + { + "label": "Feeds and other feed grains", + "value": "Feeds and other feed grains" + }, + { + "label": "Fruits, fresh", + "value": "Fruits, fresh" + }, + { + "label": "Fruits, processed", + "value": "Fruits, processed" + }, + { + "label": "Grain products", + "value": "Grain products" + }, + { + "label": "Hides and skins", + "value": "Hides and skins" + }, + { + "label": "Other livestock products", + "value": "Other livestock products" + }, + { + "label": "Other oilseeds and products", + "value": "Other oilseeds and products" + }, + { + "label": "Other plant products", + "value": "Other plant products" + }, + { + "label": "Other poultry products", + "value": "Other poultry products" + }, + { + "label": "Pork", + "value": "Pork" + }, + { + "label": "Rice", + "value": "Rice" + }, + { + "label": "Soybean meal", + "value": "Soybean meal" + }, + { + "label": "Soybeans", + "value": "Soybeans" + }, + { + "label": "Tobacco", + "value": "Tobacco" + }, + { + "label": "Tree nuts", + "value": "Tree nuts" + }, + { + "label": "Vegetable oils", + "value": "Vegetable oils" + }, + { + "label": "Vegetables, fresh", + "value": "Vegetables, fresh" + }, + { + "label": "Vegetables, processed", + "value": "Vegetables, processed" + }, + { + "label": "Wheat", + "value": "Wheat" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the calendar or fiscal year. If None, returns from the first published year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the calendar or fiscal year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "StateAgriculturalTrade", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Calendar year for the all-data tables, or fiscal year for the top-commodity tables.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "number", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State whose commodities the columns spread, for the commodity and top-commodity tables. None for the exports-by-state table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "hide": true + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity whose states the columns spread, for the exports-by-state table. None for the other tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "hide": true + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit shared by every value column: 'Million dollars' for the calendar-year tables, 'Dollars' for the fiscal-year tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + } + ] + }, + "model": "StateAgriculturalTrade", + "openapi_extra": { + "model": "StateAgriculturalTrade" + } + }, + "/usda/normalized_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS normalized prices - national and State-level normalized prices for crops, livestock, milk, poultry, eggs, and wool, plus national prices-received and prices-paid indices, each pivoted to a wide layout with report years, index years, or States in the columns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.normalized_prices(provider='usda')\n# Get the national prices-received and prices-paid indices (2011=100).\nobb.usda.normalized_prices(table='table2_national_indices', provider='usda')\n# Get State-level normalized prices for the current report year.\nobb.usda.normalized_prices(table='table3_state_prices', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. 'table1_national_prices' spreads the report years into columns with one row per commodity; 'table2_national_indices' spreads the index years into columns with one row per national price index series; 'table3_state_prices' spreads the States into columns with one row per commodity for the current report year. Valid tables are:\n table1_national_prices, table2_national_indices, table3_state_prices", + "default": "table1_national_prices", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "table1_national_prices", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 1 - National normalized prices by commodity and report year", + "value": "table1_national_prices" + }, + { + "label": "Table 2 - National price indices by series and index year (2011=100)", + "value": "table2_national_indices" + }, + { + "label": "Table 3 - State normalized prices by commodity and State", + "value": "table3_state_prices" + } + ], + "style": { + "popupWidth": 520 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NormalizedPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity (national and State price tables) or national price index series (the index table), as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "pinned": "left" + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the row's prices, as published, e.g. '$ / bu', '$ / cwt', or 'Index, 2011=100' for the price index table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Units", + "pinned": "left", + "maxWidth": 150 + } + } + }, + { + "name": "description", + "type": "str | None", + "description": "Commodity qualifier, as published, e.g. 'for grain' or 'lint, upland'. Absent for the price index table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Description", + "hide": true + } + } + } + ] + }, + "model": "NormalizedPrices", + "openapi_extra": { + "model": "NormalizedPrices" + } + }, + "/usda/agricultural_trade_multipliers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS agricultural trade multipliers - producer- and port-level output and employment multipliers per commodity, with export value, in a wide layout.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.agricultural_trade_multipliers(provider='usda')\n# Get the trade multipliers for soybeans and corn.\nobb.usda.agricultural_trade_multipliers(commodity='soybeans,corn', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AgriculturalTradeMultipliers", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "commodity_id", + "type": "int | None", + "description": "Numeric commodity identifier, as published (COMMID). None on the aggregate all-exports row.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity ID", + "cellDataType": "number", + "hide": true, + "maxWidth": 120 + } + } + }, + { + "name": "commodity", + "type": "str", + "description": "Commodity name, as published, or the aggregate 'All agricultural exports'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "cellDataType": "text", + "pinned": "left" + } + } + }, + { + "name": "year", + "type": "int", + "description": "Reference year of the multipliers and export value.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "number", + "maxWidth": 90 + } + } + }, + { + "name": "producer_output_multiplier", + "type": "float | None", + "description": "Producer output multiplier: total U.S. dollar economic output supported per U.S. dollar of the commodity's export value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Producer Output Multiplier (USD output per USD export)", + "cellDataType": "number" + } + } + }, + { + "name": "producer_employment_multiplier", + "type": "float | None", + "description": "Producer employment multiplier: jobs supported per 1 billion U.S. dollars of the commodity's export value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Producer Employment Multiplier (jobs per $1B export)", + "cellDataType": "number" + } + } + }, + { + "name": "port_output_multiplier", + "type": "float | None", + "description": "Port output multiplier: total U.S. dollar economic output supported per U.S. dollar of the commodity's export value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Port Output Multiplier (USD output per USD export)", + "cellDataType": "number" + } + } + }, + { + "name": "port_employment_multiplier", + "type": "float | None", + "description": "Port employment multiplier: jobs supported per 1 billion U.S. dollars of the commodity's export value.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Port Employment Multiplier (jobs per $1B export)", + "cellDataType": "number" + } + } + }, + { + "name": "export_value", + "type": "float | None", + "description": "Commodity export value, in thousands of U.S. dollars.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Export Value ($1,000)", + "cellDataType": "number" + } + } + } + ] + }, + "model": "AgriculturalTradeMultipliers", + "openapi_extra": { + "model": "AgriculturalTradeMultipliers" + } + }, + "/usda/agricultural_and_food_rd_expenditures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS agricultural and food research and development (R&D) expenditures - public and private U.S. R&D spending in current and constant dollars with the R&D price index, pivoted to a wide layout with the R&D series as columns and years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.agricultural_and_food_rd_expenditures(provider='usda')\n# Get nominal (current-dollar) R&D expenditures since 2000.\nobb.usda.agricultural_and_food_rd_expenditures(measure='nominal', start_year=2000, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "measure", + "type": "str | None", + "description": "Measure to retrieve, selecting which values fill the R&D series columns. 'real' is inflation-adjusted constant 2022 U.S. dollars; 'nominal' is current U.S. dollars. Both are in millions. The R&D price index column is the same under either measure.", + "default": "real", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "multiSelect": false, + "multiple": false, + "value": "real", + "options": [ + { + "label": "Real (constant 2022 dollars)", + "value": "real" + }, + { + "label": "Nominal (current dollars)", + "value": "nominal" + } + ] + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from 1970.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AgriculturalAndFoodRdExpenditures", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "public_total", + "type": "float | None", + "description": "Total public agricultural and food R&D expenditures, in millions of dollars under the selected measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Public total", + "cellDataType": "number" + } + } + }, + { + "name": "public_usda_intramural", + "type": "float | None", + "description": "Public agricultural and food R&D performed by USDA intramural agencies, in millions of dollars under the selected measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "USDA intramural", + "cellDataType": "number" + } + } + }, + { + "name": "public_state_universities", + "type": "float | None", + "description": "Public agricultural and food R&D performed by State universities and cooperating institutions, in millions of dollars under the selected measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State universities", + "cellDataType": "number" + } + } + }, + { + "name": "private_input_industries", + "type": "float | None", + "description": "Private agriculture input industries R&D, in millions of dollars under the selected measure. Discontinued after 2014.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Private input industries", + "cellDataType": "number" + } + } + }, + { + "name": "private_food_industry", + "type": "float | None", + "description": "Private food industry R&D, in millions of dollars under the selected measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Private food industry", + "cellDataType": "number" + } + } + }, + { + "name": "rd_price_index", + "type": "float | None", + "description": "R&D price index (2022 = 100) used to deflate the nominal series, the same under either measure.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "R&D price index", + "cellDataType": "number" + } + } + } + ] + }, + "model": "AgriculturalAndFoodRdExpenditures", + "openapi_extra": { + "model": "AgriculturalAndFoodRdExpenditures" + } + }, + "/usda/ge_crop_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for a crop's genetically engineered adoption data.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "crop", + "type": "str", + "description": "Crop key. Unknown crops fall back to corn.", + "default": "corn", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/adoption_of_genetically_engineered_crops": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS adoption of genetically engineered crops - the annual share of planted acres in genetically engineered corn, upland cotton, and soybean varieties, by trait and by State, pivoted to a wide layout with the GE traits as columns and years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.adoption_of_genetically_engineered_crops(provider='usda')\n# Get U.S. corn GE adoption by trait since 2010.\nobb.usda.adoption_of_genetically_engineered_crops(crop='corn', state='United States', start_year=2010, provider='usda')\n# Get Texas upland cotton GE adoption.\nobb.usda.adoption_of_genetically_engineered_crops(crop='cotton', state='Texas', provider='usda')\n# Get U.S. herbicide-tolerant soybean adoption.\nobb.usda.adoption_of_genetically_engineered_crops(crop='soybeans', state='United States', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "crop", + "type": "str | None", + "description": "Crop whose sheet is retrieved. The crop selects the trait columns and the state option list. Corn and cotton publish four trait columns (Bt only, HT only, Stacked, All GE); soybeans publish only HT only and All GE. Valid crops are:\n corn, cotton, soybeans", + "default": "corn", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Crop", + "value": "corn", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Corn", + "value": "corn" + }, + { + "label": "Upland cotton", + "value": "cotton" + }, + { + "label": "Soybeans", + "value": "soybeans" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None | list[str | None]", + "description": "State(s) to retrieve, as a comma-separated list of names. The published estimating-program states vary by crop; 'United States' is the national total and 'Other States' is the residual aggregate. If None, defaults to 'United States'. Multiple items allowed.", + "default": "United States", + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": "United States", + "optionsEndpoint": "/api/v1/usda/ge_crop_states", + "optionsParams": { + "crop": "$crop" + }, + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from 2000, the first year of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AdoptionOfGeneticallyEngineeredCropsInTheUnitedStates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "state", + "type": "str", + "description": "State of the observation, or 'United States' for the national total and 'Other States' for the residual aggregate.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left" + } + } + }, + { + "name": "year", + "type": "int", + "description": "Year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "number", + "pinned": "left", + "maxWidth": 90 + } + } + } + ] + }, + "model": "AdoptionOfGeneticallyEngineeredCropsInTheUnitedStates", + "openapi_extra": { + "model": "AdoptionOfGeneticallyEngineeredCropsInTheUnitedStates" + } + }, + "/usda/food_security_in_the_united_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS food security in the United States - household and child food security, food insecurity, and very low food security prevalence by year, characteristic, and State, each pivoted to a wide layout.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_security_in_the_united_states(provider='usda')\n# Get food security prevalence by race and ethnicity since 2015.\nobb.usda.food_security_in_the_united_states(table='by_characteristic', category='Race/ethnicity of households', start_year=2015, provider='usda')\n# Get the by-State 3-year-average food insecurity prevalence.\nobb.usda.food_security_in_the_united_states(table='by_state', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. Each table pivots a set of food-security status measures into wide columns, with the survey year or 3-year period in the rows and the characteristic path or State as pinned dimension columns. Valid tables are:\n national_trend, by_characteristic, households_with_children, child_trends, education_employment_disability, by_state", + "default": "national_trend", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "national_trend", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "National trend - all U.S. households", + "value": "national_trend" + }, + { + "label": "By household characteristic", + "value": "by_characteristic" + }, + { + "label": "Households with children", + "value": "households_with_children" + }, + { + "label": "Child food security trends", + "value": "child_trends" + }, + { + "label": "Education, employment, and disability", + "value": "education_employment_disability" + }, + { + "label": "By State (3-year averages)", + "value": "by_state" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "category", + "type": "str | None", + "description": "Filter by the household characteristic category of a table, e.g. 'Race/ethnicity of households'. If None, all categories of the selected table are included. Ignored by the by_state table, which has no category dimension.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Category", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/food_security_categories", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the survey year or the first year of a 3-year period. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the survey year or the first year of a 3-year period. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodSecurityInTheUnitedStates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "period", + "type": "str", + "description": "Row label of the observation: the survey year for annual tables ('2008') or the 3-year period for the by_state table ('2006-2008'), with any varying household characteristic or State prefixed so each row is uniquely labeled ('Households with children \u2014 2008', 'CA \u2014 2006-2008').", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Period", + "pinned": "left", + "maxWidth": 320 + } + } + } + ] + }, + "model": "FoodSecurityInTheUnitedStates", + "openapi_extra": { + "model": "FoodSecurityInTheUnitedStates" + } + }, + "/usda/food_security_categories": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the category options for a food-security table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key from FOOD_SECURITY_TABLES, e.g. 'by_characteristic'.", + "default": "by_characteristic", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/food_availability_groups": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the food-group files published for a data system.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "data_system", + "type": "str", + "description": "", + "default": "food_availability", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/food_availability_commodities": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the commodity blocks published for a data system's file.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "data_system", + "type": "str", + "description": "Data system key. Unknown systems fall back to food availability.", + "default": "food_availability", + "optional": true + }, + { + "name": "food_group", + "type": "str", + "description": "Food-group file slug. Unknown slugs fall back to the system's first file.", + "default": "eggs", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/food_availability_per_capita": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Food Availability (Per Capita) Data System - per capita food supply, loss-adjusted availability, and nutrient availability of the U.S. food supply, each file pivoted to a wide layout with the measures as columns and years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_availability_per_capita(provider='usda')\n# Get the loss-adjusted rice availability budget since 1990.\nobb.usda.food_availability_per_capita(data_system='loss_adjusted', food_group='grains', commodity='Rice: Per capita availability adjusted for loss', start_year=1990, provider='usda')\n# Get the nutrient availability of the U.S. food supply since 2000.\nobb.usda.food_availability_per_capita(data_system='nutrient', food_group='totals', start_year=2000, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "data_system", + "type": "str | None", + "description": "Data system to retrieve. Each selection downloads one cached file, pivoted to a wide layout with the measures spread into columns and the years in the rows. Valid data systems are:\n food_availability, loss_adjusted, nutrient", + "default": "food_availability", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Data system", + "value": "food_availability", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Food availability", + "value": "food_availability" + }, + { + "label": "Loss-adjusted food availability", + "value": "loss_adjusted" + }, + { + "label": "Nutrient availability", + "value": "nutrient" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "food_group", + "type": "str | None", + "description": "Food group file within the data system, as a slug. The same slug can appear under more than one data system. If None, the data system's default file is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Food group", + "type": "endpoint", + "value": "eggs", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/food_availability_groups", + "optionsParams": { + "data_system": "$data_system" + }, + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity block within the file, as its published name. If None, the file's first block is used.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/food_availability_commodities", + "optionsParams": { + "data_system": "$data_system", + "food_group": "$food_group" + }, + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodAvailabilityPerCapitaDataSystem", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Calendar year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "number", + "pinned": "left", + "maxWidth": 90 + } + } + } + ] + }, + "model": "FoodAvailabilityPerCapitaDataSystem", + "openapi_extra": { + "model": "FoodAvailabilityPerCapitaDataSystem" + } + }, + "/usda/fmap_food_items": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the food items in a Tier-1 food group.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "group", + "type": "str", + "description": "Tier-1 food group. Unknown groups fall back to the default group.", + "default": "Dairy", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/fmap_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the measures a Food-at-Home Monthly Area Prices table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key. Unknown tables fall back to the default table.", + "default": "monthly_area_prices", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/food_at_home_monthly_area_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Food-at-Home Monthly Area Prices - monthly unit values, purchases, store counts, and price indexes for a food item and measure, spread across the national, Census-region, and metropolitan areas.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_at_home_monthly_area_prices(provider='usda')\n# Get the GEKS price index for whole milk across the 15 areas.\nobb.usda.food_at_home_monthly_area_prices(item='40000', measure='price_index_geks', provider='usda')\n# Get the supplemental Fisher Ideal price index for fresh whole fruit since 2017.\nobb.usda.food_at_home_monthly_area_prices(table='supplemental_price_indexes', group='Fruit', item='30000', measure='price_index_fisher_ideal', start_year=2017, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. The main table carries the nine F-MAP price, purchase, and store measures for 2012-2018; the supplemental table carries six alternative price-index formulas for 2016-2018. Valid tables are:\n monthly_area_prices, supplemental_price_indexes", + "default": "monthly_area_prices", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "monthly_area_prices", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Monthly area prices (2012-2018)", + "value": "monthly_area_prices" + }, + { + "label": "Supplemental price indexes (2016-2018)", + "value": "supplemental_price_indexes" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "group", + "type": "str | None", + "description": "Tier-1 food group that narrows the food-item options. Ignored once an item is chosen. Valid groups are:\n Grains, Vegetables, Fruit, Dairy, Meat and Protein Foods, Prepared meals, sides, and salads, Other foods", + "default": "Dairy", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Food group", + "value": "Dairy", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Grains", + "value": "Grains" + }, + { + "label": "Vegetables", + "value": "Vegetables" + }, + { + "label": "Fruit", + "value": "Fruit" + }, + { + "label": "Dairy", + "value": "Dairy" + }, + { + "label": "Meat and Protein Foods", + "value": "Meat and Protein Foods" + }, + { + "label": "Prepared meals, sides, and salads", + "value": "Prepared meals, sides, and salads" + }, + { + "label": "Other foods", + "value": "Other foods" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "item", + "type": "str | None", + "description": "ERS Food Purchase Group (EFPG) code of the food item whose monthly area prices are spread across the area columns, e.g. '40000' for whole milk.", + "default": "40000", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Food item", + "type": "endpoint", + "value": "40000", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/fmap_food_items", + "optionsParams": { + "group": "$group" + }, + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "measure", + "type": "str | None", + "description": "Measure spread into the 15 area columns. Only measures the selected table publishes are valid; an unavailable measure falls back to the table's default. Valid measures are:\n unit_value_mean_wtd, unit_value_mean_unwtd, unit_value_se_wtd, price_index_geks, purchase_dollars_wtd, purchase_dollars_unwtd, purchase_grams_wtd, purchase_grams_unwtd, number_stores, price_index_laspeyres, price_index_paasche, price_index_tornqvist, price_index_fisher_ideal, price_index_ccd", + "default": "unit_value_mean_wtd", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "type": "endpoint", + "value": "unit_value_mean_wtd", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/fmap_measures", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 400 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from the first year of the table.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns up to the last year of the table.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodAtHomeMonthlyAreaPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "date", + "type": "date | str", + "description": "First day of the observation month.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "maxWidth": 120 + } + } + }, + { + "name": "national", + "type": "float | None", + "description": "Selected measure for the United States.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "National", + "cellDataType": "number" + } + } + }, + { + "name": "northeast", + "type": "float | None", + "description": "Selected measure for Census Region 1: Northeast.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Northeast", + "cellDataType": "number" + } + } + }, + { + "name": "midwest", + "type": "float | None", + "description": "Selected measure for Census Region 2: Midwest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Midwest", + "cellDataType": "number" + } + } + }, + { + "name": "south", + "type": "float | None", + "description": "Selected measure for Census Region 3: South.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "South", + "cellDataType": "number" + } + } + }, + { + "name": "west", + "type": "float | None", + "description": "Selected measure for Census Region 4: West.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "West", + "cellDataType": "number" + } + } + }, + { + "name": "atlanta", + "type": "float | None", + "description": "Selected measure for the Atlanta, GA metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Atlanta, GA", + "cellDataType": "number" + } + } + }, + { + "name": "boston", + "type": "float | None", + "description": "Selected measure for the Boston, MA-NH metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Boston, MA-NH", + "cellDataType": "number" + } + } + }, + { + "name": "chicago", + "type": "float | None", + "description": "Selected measure for the Chicago, IL-IN-WI metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Chicago, IL-IN-WI", + "cellDataType": "number" + } + } + }, + { + "name": "dallas", + "type": "float | None", + "description": "Selected measure for the Dallas-Fort Worth, TX metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Dallas-Fort Worth, TX", + "cellDataType": "number" + } + } + }, + { + "name": "detroit", + "type": "float | None", + "description": "Selected measure for the Detroit, MI metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Detroit, MI", + "cellDataType": "number" + } + } + }, + { + "name": "houston", + "type": "float | None", + "description": "Selected measure for the Houston, TX metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Houston, TX", + "cellDataType": "number" + } + } + }, + { + "name": "los_angeles", + "type": "float | None", + "description": "Selected measure for the Los Angeles, CA metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Los Angeles, CA", + "cellDataType": "number" + } + } + }, + { + "name": "miami", + "type": "float | None", + "description": "Selected measure for the Miami, FL metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Miami, FL", + "cellDataType": "number" + } + } + }, + { + "name": "new_york", + "type": "float | None", + "description": "Selected measure for the New York, NY-NJ-PA metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "New York, NY-NJ-PA", + "cellDataType": "number" + } + } + }, + { + "name": "philadelphia", + "type": "float | None", + "description": "Selected measure for the Philadelphia, PA-NJ-DE-MD metro area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Philadelphia, PA-NJ-DE-MD", + "cellDataType": "number" + } + } + } + ] + }, + "model": "FoodAtHomeMonthlyAreaPrices", + "openapi_extra": { + "model": "FoodAtHomeMonthlyAreaPrices" + } + }, + "/usda/rural_urban_continuum_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for a rural-urban continuum code vintage.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "vintage", + "type": "str", + "description": "A vintage key. Unknown vintages fall back to the latest, 2023.", + "default": "2023", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/rural_urban_continuum_codes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Rural-Urban Continuum Codes - a county-level lookup classifying U.S. counties by metro/nonmetro status and degree of urbanization, published in vintages from 1974 to 2023.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.rural_urban_continuum_codes(provider='usda')\n# Get the 2023 Rural-Urban Continuum Codes for Wyoming.\nobb.usda.rural_urban_continuum_codes(vintage='2023', state='WY', provider='usda')\n# Get the code-only 1974 Rural-Urban Continuum Codes for Alabama.\nobb.usda.rural_urban_continuum_codes(vintage='1974', state='AL', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "vintage", + "type": "str | None", + "description": "Classification vintage to retrieve. Each vintage is a separate county lookup published in that year, carrying the RUCC code, its vintage-specific description, and the county population; codes and descriptions are vintage-specific because the urbanization thresholds changed over time. Valid vintages are:\n 2023, 2013, 2003", + "default": "2023", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Vintage", + "value": "2023", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2023", + "value": "2023" + }, + { + "label": "2013", + "value": "2013" + }, + { + "label": "2003", + "value": "2003" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state or territory code to scope the county rows to a single state. If None, returns every county of the vintage. The available states vary by vintage: the 2023 and 2013 vintages include the AS, GU, MP, VI, PR, and DC territories, and the 2003 vintage adds PR to the fifty states and DC.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/rural_urban_continuum_states", + "optionsParams": { + "vintage": "$vintage" + }, + "style": { + "popupWidth": 280 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "RuralUrbanContinuumCodes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "fips", + "type": "str", + "description": "Five-digit county FIPS code, with leading zeros preserved.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 100 + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state or territory postal code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "county_name", + "type": "str | None", + "description": "County or county-equivalent area name, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County / area", + "pinned": "left", + "minWidth": 200 + } + } + }, + { + "name": "rucc_code", + "type": "str | None", + "description": "Rural-Urban Continuum Code for the vintage: 1 to 3 for metro counties and 4 to 9 for nonmetro counties.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RUCC code", + "cellDataType": "text", + "maxWidth": 120 + } + } + }, + { + "name": "description", + "type": "str | None", + "description": "Vintage-specific description of the RUCC code, carried per row from the source.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Description" + } + } + }, + { + "name": "population", + "type": "int | None", + "description": "Published county population for the vintage's reference census, as a full count.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population", + "cellDataType": "number", + "maxWidth": 140 + } + } + } + ] + }, + "model": "RuralUrbanContinuumCodes", + "openapi_extra": { + "model": "RuralUrbanContinuumCodes" + } + }, + "/usda/urban_influence_code_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for an Urban Influence Codes vintage.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "vintage", + "type": "str", + "description": "Vintage key. Unknown vintages fall back to the 2024 revision's states.", + "default": "2024", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/urban_influence_codes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Urban Influence Codes - a county-level classification of every U.S. county by metropolitan status, size, and adjacency to metro and micro areas, published in the 1993, 2003, 2013, and 2024 vintages as a FIPS lookup table.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.urban_influence_codes(provider='usda')\n# Get the 2024 Urban Influence Codes for Alabama counties.\nobb.usda.urban_influence_codes(vintage='2024', state='AL', provider='usda')\n# Get the 2003 codes with population density for Wyoming.\nobb.usda.urban_influence_codes(vintage='2003', state='WY', provider='usda')\n# Get the 1993 vintage codes for the whole United States.\nobb.usda.urban_influence_codes(vintage='1993', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "vintage", + "type": "str | None", + "description": "Classification vintage to retrieve; each vintage is a separate published file. The 2024 revision uses a nine-code scheme, 2013 and 2003 use a twelve-code scheme, and 1993 uses a different nine-code scheme. Valid vintages are:\n 2024, 2013, 2003, 1993", + "default": "2024", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Vintage", + "value": "2024", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2024 revision (9-code scheme)", + "value": "2024" + }, + { + "label": "2013 (12-code scheme)", + "value": "2013" + }, + { + "label": "2003 (12-code scheme)", + "value": "2003" + }, + { + "label": "1993 (9-code scheme)", + "value": "1993" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State to retrieve, as a two-letter code, scoping the rows to one state's counties. If None, every county in the vintage is returned. The published state set varies by vintage: the 2024 revision adds the American Samoa, Guam, Northern Mariana Islands, Puerto Rico, and U.S. Virgin Islands territories, 2013 and 2003 add Puerto Rico, and 1993 covers the states and the District of Columbia only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/urban_influence_code_states", + "optionsParams": { + "vintage": "$vintage" + }, + "style": { + "popupWidth": 280 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UrbanInfluenceCodes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "fips", + "type": "str", + "description": "Five-digit county FIPS code, zero-padded.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 110 + } + } + }, + { + "name": "state", + "type": "str", + "description": "Two-letter state or territory postal code of the county.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "county_name", + "type": "str", + "description": "County or municipio name, as published.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "pinned": "left" + } + } + }, + { + "name": "urban_influence_code", + "type": "str | None", + "description": "Urban Influence Code of the county, as an ordinal string: one to nine for the 2024 and 1993 vintages, one to twelve for the 2013 and 2003 vintages.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "UIC", + "cellDataType": "text", + "maxWidth": 90 + } + } + }, + { + "name": "description", + "type": "str | None", + "description": "Published description of the county's Urban Influence Code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Description" + } + } + }, + { + "name": "population", + "type": "float | int | None", + "description": "Published population count of the county; the 2020 census for the 2024 vintage, the 2010 census for 2013, and the 2000 census for the 2003 and 1993 vintages.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population", + "cellDataType": "number" + } + } + }, + { + "name": "population_density", + "type": "float | None", + "description": "Published population density in persons per square mile, from the 2000 census. Populated only for the 2003 and 1993 vintages; the 2024 and 2013 files carry no density.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persons per sq. mile", + "cellDataType": "number", + "hide": true + } + } + } + ] + }, + "model": "UrbanInfluenceCodes", + "openapi_extra": { + "model": "UrbanInfluenceCodes" + } + }, + "/usda/county_typology_codes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS County Typology Codes - county-level economic-dependence and policy typology classifications, published in successive vintages, as a one-row-per-county lookup table scoped by edition and state.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.county_typology_codes(provider='usda')\n# Get the 2025-edition county typology codes for Texas.\nobb.usda.county_typology_codes(vintage='2025', state='TX', provider='usda')\n# Get the 2004-edition county economic and policy types.\nobb.usda.county_typology_codes(vintage='2004', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "vintage", + "type": "str | None", + "description": "Typology-codes edition to retrieve. Each edition is a separate published vintage of the county classification, keyed by county FIPS. Valid editions are:\n 2025, 2015, 2004, 1989, 1979_1986_1983def, 1979_1986_1974def", + "default": "2025", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Edition", + "value": "2025", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2025 Edition", + "value": "2025" + }, + { + "label": "2015 Edition", + "value": "2015" + }, + { + "label": "2004 Edition", + "value": "2004" + }, + { + "label": "1989 Edition", + "value": "1989" + }, + { + "label": "1979 and 1986 (1983 nonmetro definition)", + "value": "1979_1986_1983def" + }, + { + "label": "1979 and 1986 (1974 nonmetro definition)", + "value": "1979_1986_1974def" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state postal abbreviation to scope the county rows to a single state. If None, returns every county in the edition. Alaska and Hawaii are absent from the 1979/1986 editions.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Alabama", + "value": "AL" + }, + { + "label": "Alaska", + "value": "AK" + }, + { + "label": "Arizona", + "value": "AZ" + }, + { + "label": "Arkansas", + "value": "AR" + }, + { + "label": "California", + "value": "CA" + }, + { + "label": "Colorado", + "value": "CO" + }, + { + "label": "Connecticut", + "value": "CT" + }, + { + "label": "Delaware", + "value": "DE" + }, + { + "label": "District of Columbia", + "value": "DC" + }, + { + "label": "Florida", + "value": "FL" + }, + { + "label": "Georgia", + "value": "GA" + }, + { + "label": "Hawaii", + "value": "HI" + }, + { + "label": "Idaho", + "value": "ID" + }, + { + "label": "Illinois", + "value": "IL" + }, + { + "label": "Indiana", + "value": "IN" + }, + { + "label": "Iowa", + "value": "IA" + }, + { + "label": "Kansas", + "value": "KS" + }, + { + "label": "Kentucky", + "value": "KY" + }, + { + "label": "Louisiana", + "value": "LA" + }, + { + "label": "Maine", + "value": "ME" + }, + { + "label": "Maryland", + "value": "MD" + }, + { + "label": "Massachusetts", + "value": "MA" + }, + { + "label": "Michigan", + "value": "MI" + }, + { + "label": "Minnesota", + "value": "MN" + }, + { + "label": "Mississippi", + "value": "MS" + }, + { + "label": "Missouri", + "value": "MO" + }, + { + "label": "Montana", + "value": "MT" + }, + { + "label": "Nebraska", + "value": "NE" + }, + { + "label": "Nevada", + "value": "NV" + }, + { + "label": "New Hampshire", + "value": "NH" + }, + { + "label": "New Jersey", + "value": "NJ" + }, + { + "label": "New Mexico", + "value": "NM" + }, + { + "label": "New York", + "value": "NY" + }, + { + "label": "North Carolina", + "value": "NC" + }, + { + "label": "North Dakota", + "value": "ND" + }, + { + "label": "Ohio", + "value": "OH" + }, + { + "label": "Oklahoma", + "value": "OK" + }, + { + "label": "Oregon", + "value": "OR" + }, + { + "label": "Pennsylvania", + "value": "PA" + }, + { + "label": "Rhode Island", + "value": "RI" + }, + { + "label": "South Carolina", + "value": "SC" + }, + { + "label": "South Dakota", + "value": "SD" + }, + { + "label": "Tennessee", + "value": "TN" + }, + { + "label": "Texas", + "value": "TX" + }, + { + "label": "Utah", + "value": "UT" + }, + { + "label": "Vermont", + "value": "VT" + }, + { + "label": "Virginia", + "value": "VA" + }, + { + "label": "Washington", + "value": "WA" + }, + { + "label": "West Virginia", + "value": "WV" + }, + { + "label": "Wisconsin", + "value": "WI" + }, + { + "label": "Wyoming", + "value": "WY" + } + ], + "style": { + "popupWidth": 260 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CountyTypologyCodes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "fips", + "type": "str", + "description": "County FIPS code, five digits with a leading zero.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state postal abbreviation, from the FIPS prefix.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "county_name", + "type": "str | None", + "description": "County name, as published in the edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 240 + } + } + }, + { + "name": "metro", + "type": "int | None", + "description": "Metro-nonmetro status: 1 for metropolitan, 0 for nonmetropolitan, under the edition's own metro definition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metro", + "cellDataType": "text" + } + } + }, + { + "name": "economic_type", + "type": "str | None", + "description": "Non-overlapping economic-dependence type of the county, e.g. 'Farming', 'Mining', 'Manufacturing', 'Government', 'Recreation', 'Services', or 'Nonspecialized'. Derived from the edition's economic code or, for the flag-based 1989 and 1979/1986 editions, from the set economic flag.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Economic Type", + "cellDataType": "text" + } + } + }, + { + "name": "economic_type_code", + "type": "int | None", + "description": "Numeric economic-dependence code as published, where the edition assigns one (2025, 2015, and 2004 editions).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Economic Type Code", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "economic_type_label", + "type": "str | None", + "description": "Economic-type label exactly as published, kept for the 2015 edition (which carries a 'Maufacturing' source typo).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Economic Type (published)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "farming", + "type": "int | None", + "description": "Farming specialization flag: a high-concentration flag in the 2025 edition, a dependence flag in earlier editions. Sentinels are kept raw (99 = not available in 2025; 8/9 = metro county in the 1989 and 1979/1986 editions).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farming", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "mining", + "type": "int | None", + "description": "Mining specialization flag, kept raw with the edition's sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "manufacturing", + "type": "int | None", + "description": "Manufacturing specialization flag, kept raw with the edition's sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Manufacturing", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "government", + "type": "int | None", + "description": "Government specialization flag, kept raw with the edition's sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "recreation", + "type": "int | None", + "description": "Recreation flag: an economic specialization in the 2025 and 2015 editions, a nonmetro-recreation policy flag in the 2004 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recreation", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "services", + "type": "int | None", + "description": "Services specialization flag, published in the 2004 and 1989 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Services", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "nonspecialized", + "type": "int | None", + "description": "Nonspecialized flag: the county is not dependent on any single industry.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonspecialized", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "low_education", + "type": "int | None", + "description": "Low-education policy flag, published in the 2025, 2015, and 2004 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Low Education", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "low_employment", + "type": "int | None", + "description": "Low-employment policy flag, published in the 2025, 2015, and 2004 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Low Employment", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "population_loss", + "type": "int | None", + "description": "Population-loss policy flag, published in the 2025, 2015, and 2004 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population Loss", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "housing_stress", + "type": "int | None", + "description": "Housing-stress policy flag, published in the 2025 and 2004 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Housing Stress", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "retirement_destination", + "type": "int | None", + "description": "Retirement-destination policy flag, kept raw with the edition's sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Retirement Destination", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "persistent_poverty", + "type": "int | None", + "description": "Persistent-poverty policy flag, kept raw with the edition's sentinels (-1 = not determined in the 2025 edition).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Poverty", + "cellDataType": "text", + "hide": false + } + } + }, + { + "name": "persistent_child_poverty", + "type": "int | None", + "description": "Persistent related-child-poverty policy flag, published in the 2015 and 2004 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Child Poverty", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "federal_lands", + "type": "int | None", + "description": "Federal-lands policy flag, published in the 1989 and 1979/1986 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Federal Lands", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "commuting", + "type": "int | None", + "description": "Commuting policy flag, published in the 1989 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commuting", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "transfers_dependent", + "type": "int | None", + "description": "Transfers-dependent policy flag, published in the 1989 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transfers Dependent", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "rural_urban_continuum_code", + "type": "int | None", + "description": "Rural-urban continuum (Beale) code, published in the 2004, 1989, and 1979/1986 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rural-Urban Continuum Code", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "urban_influence_code", + "type": "int | None", + "description": "Urban-influence code, published in the 2004 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Urban Influence Code", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "farming_1986", + "type": "int | None", + "description": "Farming specialization flag for the 1986 update carried in the 1979/1986 editions, kept raw with sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Farming (1986)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "mining_1986", + "type": "int | None", + "description": "Mining specialization flag for the 1986 update carried in the 1979/1986 editions, kept raw with sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mining (1986)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "manufacturing_1986", + "type": "int | None", + "description": "Manufacturing specialization flag for the 1986 update carried in the 1979/1986 editions, kept raw with sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Manufacturing (1986)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "government_1986", + "type": "int | None", + "description": "Government specialization flag for the 1986 update carried in the 1979/1986 editions, kept raw with sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Government (1986)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "nonspecialized_1986", + "type": "int | None", + "description": "Nonspecialized flag for the 1986 update carried in the 1979/1986 editions, kept raw with sentinels.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Nonspecialized (1986)", + "cellDataType": "text", + "hide": true + } + } + } + ] + }, + "model": "CountyTypologyCodes", + "openapi_extra": { + "model": "CountyTypologyCodes" + } + }, + "/usda/ruca_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for a rural-urban commuting area table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "Table key. Unknown tables fall back to the 2020 census-tract states.", + "default": "tract_2020", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/rural_urban_commuting_area_codes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS rural-urban commuting area (RUCA) codes - primary and secondary RUCA classification codes and descriptions for U.S. census tracts and ZIP codes across the 1990, 2000, 2010, and 2020 vintages, as a per-area lookup table scoped by state.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.rural_urban_commuting_area_codes(provider='usda')\n# Get the 2020 census-tract RUCA codes for Delaware.\nobb.usda.rural_urban_commuting_area_codes(table='tract_2020', state='DE', provider='usda')\n# Get the 2010 ZIP-code RUCA codes for Vermont.\nobb.usda.rural_urban_commuting_area_codes(table='zip_2010', state='VT', provider='usda')\n# Get the 1990 census-tract RUCA codes for Wyoming.\nobb.usda.rural_urban_commuting_area_codes(table='tract_1990', state='WY', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Vintage and geography of the code set to retrieve, as one lookup table per census-tract or ZIP-code vintage. Valid tables are:\n tract_2020, tract_2010, tract_2000, tract_1990, zip_2020, zip_2010", + "default": "tract_2020", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "tract_2020", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Census tracts, 2020", + "value": "tract_2020" + }, + { + "label": "Census tracts, 2010", + "value": "tract_2010" + }, + { + "label": "Census tracts, 2000", + "value": "tract_2000" + }, + { + "label": "Census tracts, 1990", + "value": "tract_1990" + }, + { + "label": "ZIP codes, 2020", + "value": "zip_2020" + }, + { + "label": "ZIP codes, 2010", + "value": "zip_2010" + } + ], + "style": { + "popupWidth": 260 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state or territory code to scope the lookup to, e.g. 'DE'. If None, every area in the table is returned, which is tens of thousands of rows. The set of states differs by table.", + "default": "DE", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "value": "DE", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/ruca_states", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 280 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "RuralUrbanCommutingAreaCodes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "area_fips", + "type": "str", + "description": "Geographic identifier of the row: the 11-digit census tract FIPS code for a tract table, or the 5-digit ZIP code for a ZIP table.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS / ZIP Code", + "cellDataType": "text", + "pinned": "left" + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state or territory code of the area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "county", + "type": "str | None", + "description": "County of the census tract, for the tract tables that publish it. Not published for the ZIP or 1990 tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "cellDataType": "text", + "pinned": "left", + "minWidth": 160 + } + } + }, + { + "name": "area_name", + "type": "str | None", + "description": "Name of the area: the census-tract name for the 2020 tract table or the post-office name for the 2020 ZIP table. Not published for the other tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area name", + "cellDataType": "text", + "minWidth": 160 + } + } + }, + { + "name": "area_type", + "type": "str | None", + "description": "Type of the ZIP record, 'ZIP Code Area' or a post office or large-volume customer, for the ZIP tables. Not published for the tract tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ZIP type", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "primary_ruca", + "type": "str | None", + "description": "Primary RUCA code, a whole number 1 to 10 or 99, classifying the area by its primary commuting flow.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary RUCA", + "cellDataType": "text", + "maxWidth": 130 + } + } + }, + { + "name": "primary_ruca_description", + "type": "str | None", + "description": "Description of the primary RUCA code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary RUCA description", + "cellDataType": "text" + } + } + }, + { + "name": "secondary_ruca", + "type": "str | None", + "description": "Secondary RUCA code, the primary code optionally extended with a decimal sub-code for a secondary commuting flow.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Secondary RUCA", + "cellDataType": "text", + "maxWidth": 140 + } + } + }, + { + "name": "secondary_ruca_description", + "type": "str | None", + "description": "Description of the secondary RUCA code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Secondary RUCA description", + "cellDataType": "text" + } + } + }, + { + "name": "population", + "type": "int | None", + "description": "Population of the area in the vintage year, for the tract tables that publish it. Not published for the ZIP tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population", + "cellDataType": "number", + "maxWidth": 140 + } + } + }, + { + "name": "land_area", + "type": "float | None", + "description": "Land area of the tract in square miles, for the tract tables that publish it. Not published for the 2000 or ZIP tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Land area (sq mi)", + "cellDataType": "number", + "maxWidth": 150 + } + } + }, + { + "name": "population_density", + "type": "float | None", + "description": "Population per square mile of the tract, for the 2020 and 2010 tract tables that publish it.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population density (per sq mi)", + "cellDataType": "number", + "maxWidth": 200 + } + } + } + ] + }, + "model": "RuralUrbanCommutingAreaCodes", + "openapi_extra": { + "model": "RuralUrbanCommutingAreaCodes" + } + }, + "/usda/far_zip_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states a frontier and remote area codes ZIP vintage publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "year", + "type": "str", + "description": "Vintage key. Unknown vintages fall back to the latest vintage.", + "default": "2020", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/frontier_and_remote_area_codes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS frontier and remote (FAR) area codes - a ZIP-code geographic classification lookup at four FAR levels with grid population, land area, and population density, in a single-vintage lookup table scoped by State.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.frontier_and_remote_area_codes(provider='usda')\n# Get the 2020 frontier and remote area codes for California ZIP Codes.\nobb.usda.frontier_and_remote_area_codes(year='2020', state='CA', provider='usda')\n# Get the 2000 vintage for Massachusetts ZIP Codes.\nobb.usda.frontier_and_remote_area_codes(year='2000', state='MA', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "str | None", + "description": "Decennial classification vintage to retrieve, selecting the source workbook. Valid vintages are:\n 2020, 2010, 2000", + "default": "2020", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Vintage", + "value": "2020", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2020", + "value": "2020" + }, + { + "label": "2010", + "value": "2010" + }, + { + "label": "2000", + "value": "2000" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State to retrieve, as a two-letter postal abbreviation. The ZIP-code lookup carries tens of thousands of rows, so the state is the primary scope filter. The 2000 vintage covers the contiguous States and excludes Alaska and Hawaii. If None, defaults to Montana.", + "default": "MT", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": "MT", + "optionsEndpoint": "/api/v1/usda/far_zip_states", + "optionsParams": { + "year": "$year" + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FrontierAndRemoteAreaCodes", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "zip_code", + "type": "str", + "description": "ZIP Code of the area.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ZIP Code", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 110 + } + } + }, + { + "name": "state", + "type": "str", + "description": "Two-letter postal abbreviation of the area's State.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "po_name", + "type": "str | None", + "description": "Post office name of the ZIP-code area, as published. The 2000 vintage carries no area name.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area Name", + "cellDataType": "text", + "pinned": "left", + "hide": true + } + } + }, + { + "name": "far_level_1", + "type": "int | None", + "description": "FAR level 1 flag: 1 when the area is frontier and remote at level 1, else 0.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 1", + "cellDataType": "text", + "maxWidth": 110 + } + } + }, + { + "name": "far_level_2", + "type": "int | None", + "description": "FAR level 2 flag: 1 when the area is frontier and remote at level 2, else 0.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 2", + "cellDataType": "text", + "maxWidth": 110 + } + } + }, + { + "name": "far_level_3", + "type": "int | None", + "description": "FAR level 3 flag: 1 when the area is frontier and remote at level 3, else 0.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 3", + "cellDataType": "text", + "maxWidth": 110 + } + } + }, + { + "name": "far_level_4", + "type": "int | None", + "description": "FAR level 4 flag: 1 when the area is frontier and remote at level 4, else 0.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 4", + "cellDataType": "text", + "maxWidth": 110 + } + } + }, + { + "name": "grid_population", + "type": "float | None", + "description": "Population of the area's populated grid cells.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Grid Population", + "cellDataType": "number" + } + } + }, + { + "name": "land_area_sq_mi", + "type": "float | None", + "description": "Land area of the area, in square miles.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Land Area (sq mi)", + "cellDataType": "number" + } + } + }, + { + "name": "population_density", + "type": "float | None", + "description": "Population density of the area, in persons per square mile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population Density", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_1_population", + "type": "float | None", + "description": "Population of the area classified as FAR level 1.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 1 Population", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_2_population", + "type": "float | None", + "description": "Population of the area classified as FAR level 2.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 2 Population", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_3_population", + "type": "float | None", + "description": "Population of the area classified as FAR level 3.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 3 Population", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_4_population", + "type": "float | None", + "description": "Population of the area classified as FAR level 4.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 4 Population", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_1_population_pct", + "type": "float | None", + "description": "Share of the area's grid population classified as FAR level 1, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 1 Population %", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_2_population_pct", + "type": "float | None", + "description": "Share of the area's grid population classified as FAR level 2, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 2 Population %", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_3_population_pct", + "type": "float | None", + "description": "Share of the area's grid population classified as FAR level 3, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 3 Population %", + "cellDataType": "number" + } + } + }, + { + "name": "far_level_4_population_pct", + "type": "float | None", + "description": "Share of the area's grid population classified as FAR level 4, in percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FAR Level 4 Population %", + "cellDataType": "number" + } + } + } + ] + }, + "model": "FrontierAndRemoteAreaCodes", + "openapi_extra": { + "model": "FrontierAndRemoteAreaCodes" + } + }, + "/usda/commuting_zones_and_labor_market_areas": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS commuting zones and labor market areas - county-level commuting-zone and labor-market-area classifications for the 2020, preliminary 2020, 2000, and 1980/1990 vintages, as a FIPS lookup table selectable by vintage and filterable by state.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.commuting_zones_and_labor_market_areas(provider='usda')\n# Get the 2020 commuting zones for Texas counties.\nobb.usda.commuting_zones_and_labor_market_areas(vintage='2020', state='Texas', provider='usda')\n# Get the 2000 commuting-zone crosswalk for all counties.\nobb.usda.commuting_zones_and_labor_market_areas(vintage='2000', provider='usda')\n# Get the 1980/1990 commuting zones and labor market areas.\nobb.usda.commuting_zones_and_labor_market_areas(vintage='1980_1990', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "vintage", + "type": "str | None", + "description": "Classification vintage to retrieve. Each vintage is a separate county lookup published for a base year; the county rows and their commuting-zone codes replace one another across vintages rather than forming a time series. Valid vintages are:\n 2020, preliminary_2020, 2000, 1980_1990", + "default": "2020", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Vintage", + "value": "2020", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2020 Commuting Zones", + "value": "2020" + }, + { + "label": "Preliminary 2020 Commuting Zones", + "value": "preliminary_2020" + }, + { + "label": "2000 Commuting Zones", + "value": "2000" + }, + { + "label": "1980 and 1990 Commuting Zones and Labor Market Areas", + "value": "1980_1990" + } + ], + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State to retrieve, by full name, e.g. 'Texas'. If None, all states are returned. Puerto Rico is published for the 2020 and preliminary 2020 vintages only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Alabama", + "value": "Alabama" + }, + { + "label": "Alaska", + "value": "Alaska" + }, + { + "label": "Arizona", + "value": "Arizona" + }, + { + "label": "Arkansas", + "value": "Arkansas" + }, + { + "label": "California", + "value": "California" + }, + { + "label": "Colorado", + "value": "Colorado" + }, + { + "label": "Connecticut", + "value": "Connecticut" + }, + { + "label": "Delaware", + "value": "Delaware" + }, + { + "label": "District of Columbia", + "value": "District of Columbia" + }, + { + "label": "Florida", + "value": "Florida" + }, + { + "label": "Georgia", + "value": "Georgia" + }, + { + "label": "Hawaii", + "value": "Hawaii" + }, + { + "label": "Idaho", + "value": "Idaho" + }, + { + "label": "Illinois", + "value": "Illinois" + }, + { + "label": "Indiana", + "value": "Indiana" + }, + { + "label": "Iowa", + "value": "Iowa" + }, + { + "label": "Kansas", + "value": "Kansas" + }, + { + "label": "Kentucky", + "value": "Kentucky" + }, + { + "label": "Louisiana", + "value": "Louisiana" + }, + { + "label": "Maine", + "value": "Maine" + }, + { + "label": "Maryland", + "value": "Maryland" + }, + { + "label": "Massachusetts", + "value": "Massachusetts" + }, + { + "label": "Michigan", + "value": "Michigan" + }, + { + "label": "Minnesota", + "value": "Minnesota" + }, + { + "label": "Mississippi", + "value": "Mississippi" + }, + { + "label": "Missouri", + "value": "Missouri" + }, + { + "label": "Montana", + "value": "Montana" + }, + { + "label": "Nebraska", + "value": "Nebraska" + }, + { + "label": "Nevada", + "value": "Nevada" + }, + { + "label": "New Hampshire", + "value": "New Hampshire" + }, + { + "label": "New Jersey", + "value": "New Jersey" + }, + { + "label": "New Mexico", + "value": "New Mexico" + }, + { + "label": "New York", + "value": "New York" + }, + { + "label": "North Carolina", + "value": "North Carolina" + }, + { + "label": "North Dakota", + "value": "North Dakota" + }, + { + "label": "Ohio", + "value": "Ohio" + }, + { + "label": "Oklahoma", + "value": "Oklahoma" + }, + { + "label": "Oregon", + "value": "Oregon" + }, + { + "label": "Pennsylvania", + "value": "Pennsylvania" + }, + { + "label": "Puerto Rico", + "value": "Puerto Rico" + }, + { + "label": "Rhode Island", + "value": "Rhode Island" + }, + { + "label": "South Carolina", + "value": "South Carolina" + }, + { + "label": "South Dakota", + "value": "South Dakota" + }, + { + "label": "Tennessee", + "value": "Tennessee" + }, + { + "label": "Texas", + "value": "Texas" + }, + { + "label": "Utah", + "value": "Utah" + }, + { + "label": "Vermont", + "value": "Vermont" + }, + { + "label": "Virginia", + "value": "Virginia" + }, + { + "label": "Washington", + "value": "Washington" + }, + { + "label": "West Virginia", + "value": "West Virginia" + }, + { + "label": "Wisconsin", + "value": "Wisconsin" + }, + { + "label": "Wyoming", + "value": "Wyoming" + } + ], + "style": { + "popupWidth": 260 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CommutingZonesAndLaborMarketAreas", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "fips", + "type": "str", + "description": "Five-digit county FIPS code.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 120 + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Full state name, derived from the county FIPS code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "pinned": "left" + } + } + }, + { + "name": "county_name", + "type": "str | None", + "description": "County name, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "pinned": "left" + } + } + }, + { + "name": "commuting_zone", + "type": "str | None", + "description": "Primary commuting-zone identifier of the vintage: CZ2020 for 2020, the preliminary CZ for preliminary 2020, the 2000 commuting-zone id for 2000, and CZ90 for 1980/1990.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commuting Zone", + "cellDataType": "text" + } + } + }, + { + "name": "commuting_zone_name", + "type": "str | None", + "description": "Commuting-zone name for the 2020 vintage, or the name of the largest place in the commuting zone for the 1980/1990 vintage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commuting Zone Name" + } + } + }, + { + "name": "cz_containment", + "type": "float | None", + "description": "Percent of the county's commuters contained within its commuting zone. 2020 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Containment (%)", + "cellDataType": "number" + } + } + }, + { + "name": "cz_avg_containment", + "type": "float | None", + "description": "Average commuter containment across the counties of the commuting zone, in percent. 2020 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Avg. Containment (%)", + "cellDataType": "number" + } + } + }, + { + "name": "cz_1990", + "type": "str | None", + "description": "1990 commuting-zone identifier of the county. 2000 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commuting Zone (1990)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "cz_1980", + "type": "str | None", + "description": "1980 commuting-zone identifier of the county, published in the 2000 and 1980/1990 vintages.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commuting Zone (1980)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "metro_area", + "type": "str | None", + "description": "2003 metropolitan or micropolitan area of the county, as published. 2000 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metropolitan Area (2003)", + "hide": true + } + } + }, + { + "name": "county_population", + "type": "int | None", + "description": "County population: the 2000 census count for the 2000 vintage, or the 1990 census count for the 1980/1990 vintage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County Population", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "commuting_zone_population", + "type": "int | None", + "description": "2000 census population of the commuting zone. 2000 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commuting Zone Population", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "distance", + "type": "float | None", + "description": "Cluster distance metric of the county's assignment to its commuting zone. 1980/1990 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Distance", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "beale_code", + "type": "str | None", + "description": "1993 rural-urban continuum (Beale) code of the county. 1980/1990 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beale Code (1993)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "msa_code", + "type": "str | None", + "description": "1993 metropolitan statistical area code of the county. 1980/1990 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "MSA Code (1993)", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "msa_name", + "type": "str | None", + "description": "1993 metropolitan statistical area name of the county. 1980/1990 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "MSA Name (1993)", + "hide": true + } + } + }, + { + "name": "place_code", + "type": "str | None", + "description": "State place code of the largest place in the commuting zone. 1980/1990 vintage only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State Place Code", + "cellDataType": "text", + "hide": true + } + } + } + ] + }, + "model": "CommutingZonesAndLaborMarketAreas", + "openapi_extra": { + "model": "CommutingZonesAndLaborMarketAreas" + } + }, + "/usda/natural_amenities_scale": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS natural amenities scale - a county-level measure of the physical characteristics that make a location a desirable place to live, combining six standardized climate, topography, and water-area components into a composite amenity scale and a 1-to-7 rank, as a one-row-per-county FIPS lookup scoped by state.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.natural_amenities_scale(provider='usda')\n# Get the natural amenities scale for Rhode Island counties.\nobb.usda.natural_amenities_scale(state='RI', provider='usda')\n# Get the natural amenities scale for California counties.\nobb.usda.natural_amenities_scale(state='CA', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "state", + "type": "str | None", + "description": "Two-letter state postal abbreviation to scope the county rows to a single state. If None, returns every county. The scale covers the 48 contiguous states and the District of Columbia; Alaska, Hawaii, and the territories are not scored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Alabama", + "value": "AL" + }, + { + "label": "Arkansas", + "value": "AR" + }, + { + "label": "Arizona", + "value": "AZ" + }, + { + "label": "California", + "value": "CA" + }, + { + "label": "Colorado", + "value": "CO" + }, + { + "label": "Connecticut", + "value": "CT" + }, + { + "label": "District of Columbia", + "value": "DC" + }, + { + "label": "Delaware", + "value": "DE" + }, + { + "label": "Florida", + "value": "FL" + }, + { + "label": "Georgia", + "value": "GA" + }, + { + "label": "Iowa", + "value": "IA" + }, + { + "label": "Idaho", + "value": "ID" + }, + { + "label": "Illinois", + "value": "IL" + }, + { + "label": "Indiana", + "value": "IN" + }, + { + "label": "Kansas", + "value": "KS" + }, + { + "label": "Kentucky", + "value": "KY" + }, + { + "label": "Louisiana", + "value": "LA" + }, + { + "label": "Massachusetts", + "value": "MA" + }, + { + "label": "Maryland", + "value": "MD" + }, + { + "label": "Maine", + "value": "ME" + }, + { + "label": "Michigan", + "value": "MI" + }, + { + "label": "Minnesota", + "value": "MN" + }, + { + "label": "Missouri", + "value": "MO" + }, + { + "label": "Mississippi", + "value": "MS" + }, + { + "label": "Montana", + "value": "MT" + }, + { + "label": "North Carolina", + "value": "NC" + }, + { + "label": "North Dakota", + "value": "ND" + }, + { + "label": "Nebraska", + "value": "NE" + }, + { + "label": "New Hampshire", + "value": "NH" + }, + { + "label": "New Jersey", + "value": "NJ" + }, + { + "label": "New Mexico", + "value": "NM" + }, + { + "label": "Nevada", + "value": "NV" + }, + { + "label": "New York", + "value": "NY" + }, + { + "label": "Ohio", + "value": "OH" + }, + { + "label": "Oklahoma", + "value": "OK" + }, + { + "label": "Oregon", + "value": "OR" + }, + { + "label": "Pennsylvania", + "value": "PA" + }, + { + "label": "Rhode Island", + "value": "RI" + }, + { + "label": "South Carolina", + "value": "SC" + }, + { + "label": "South Dakota", + "value": "SD" + }, + { + "label": "Tennessee", + "value": "TN" + }, + { + "label": "Texas", + "value": "TX" + }, + { + "label": "Utah", + "value": "UT" + }, + { + "label": "Virginia", + "value": "VA" + }, + { + "label": "Vermont", + "value": "VT" + }, + { + "label": "Washington", + "value": "WA" + }, + { + "label": "Wisconsin", + "value": "WI" + }, + { + "label": "West Virginia", + "value": "WV" + }, + { + "label": "Wyoming", + "value": "WY" + } + ], + "style": { + "popupWidth": 260 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "NaturalAmenitiesScale", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "fips", + "type": "str", + "description": "County FIPS code, five digits with a leading zero.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 100 + } + } + }, + { + "name": "fips_used_for_measures", + "type": "str | None", + "description": "County FIPS whose measures this row carries, equal to the FIPS code except for the 41 combined areas whose measures are reported under a neighboring county.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS Used for Measures", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state postal abbreviation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "county_name", + "type": "str | None", + "description": "County or county-equivalent area name, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "pinned": "left", + "minWidth": 180 + } + } + }, + { + "name": "census_division", + "type": "str | None", + "description": "Census division code, 1 to 9.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Census Division", + "cellDataType": "text", + "maxWidth": 150 + } + } + }, + { + "name": "rural_urban_continuum_code", + "type": "str | None", + "description": "Rural-Urban Continuum (Beale) code, 1993 vintage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rural-Urban Continuum Code (1993)", + "cellDataType": "text" + } + } + }, + { + "name": "urban_influence_code", + "type": "str | None", + "description": "Urban Influence Code, 1993 vintage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Urban Influence Code (1993)", + "cellDataType": "text" + } + } + }, + { + "name": "mean_january_temperature", + "type": "float | None", + "description": "Mean January temperature in degrees Fahrenheit, 1941-70.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mean January Temp (F)", + "cellDataType": "number" + } + } + }, + { + "name": "mean_january_sunlight", + "type": "float | None", + "description": "Mean hours of January sunlight, 1941-70.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mean January Sunlight (hrs)", + "cellDataType": "number" + } + } + }, + { + "name": "mean_july_temperature", + "type": "float | None", + "description": "Mean July temperature in degrees Fahrenheit, 1941-70.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mean July Temp (F)", + "cellDataType": "number" + } + } + }, + { + "name": "mean_july_humidity", + "type": "float | None", + "description": "Mean relative July humidity in percent, 1941-70.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Mean July Humidity (%)", + "cellDataType": "number" + } + } + }, + { + "name": "topography_code", + "type": "str | None", + "description": "Land surface form topography code, 1 to 21.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Topography Code", + "cellDataType": "text" + } + } + }, + { + "name": "percent_water_area", + "type": "float | None", + "description": "Water area as a percent of the county's total area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Percent Water Area", + "cellDataType": "number" + } + } + }, + { + "name": "log_water_area", + "type": "float | None", + "description": "Natural log of the county's water area times 100.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Log Water Area x100", + "cellDataType": "number" + } + } + }, + { + "name": "january_temperature_z", + "type": "float | None", + "description": "Standardized Z-score of the mean January temperature.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jan Temp (Z)", + "cellDataType": "number" + } + } + }, + { + "name": "january_sunlight_z", + "type": "float | None", + "description": "Standardized Z-score of the mean January sunlight.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jan Sun (Z)", + "cellDataType": "number" + } + } + }, + { + "name": "july_temperature_z", + "type": "float | None", + "description": "Standardized Z-score of the mean July temperature.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jul Temp (Z)", + "cellDataType": "number" + } + } + }, + { + "name": "july_humidity_z", + "type": "float | None", + "description": "Standardized Z-score of the mean July humidity, inverted so that lower humidity scores higher.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Jul Humidity (Z)", + "cellDataType": "number" + } + } + }, + { + "name": "topography_z", + "type": "float | None", + "description": "Standardized Z-score of the topography code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Topography (Z)", + "cellDataType": "number" + } + } + }, + { + "name": "log_water_area_z", + "type": "float | None", + "description": "Standardized Z-score of the log water area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Log Water Area (Z)", + "cellDataType": "number" + } + } + }, + { + "name": "natural_amenity_scale", + "type": "float | None", + "description": "Composite natural amenity scale, the sum of the six standardized Z-scores.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Natural Amenity Scale", + "cellDataType": "number" + } + } + }, + { + "name": "natural_amenity_rank", + "type": "str | None", + "description": "Natural amenity rank derived from the scale, 1 for the lowest amenity through 7 for the highest.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Amenity Rank (1=Low, 7=High)", + "cellDataType": "text" + } + } + } + ] + }, + "model": "NaturalAmenitiesScale", + "openapi_extra": { + "model": "NaturalAmenitiesScale" + } + }, + "/usda/poverty_area_measures_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states published for a poverty area measures edition.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "edition", + "type": "str", + "description": "An edition key. Unknown editions fall back to the latest, 2025.", + "default": "2025", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/poverty_area_measures": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Poverty Area Measures - county- and census-tract-level poverty-area classification flags (high-poverty, extreme-poverty, persistent-poverty, and enduring-poverty), published in successive editions as a FIPS/tract lookup table scoped by edition, geography level, and state.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.poverty_area_measures(provider='usda')\n# Get the 2025-edition county poverty-area measures for Mississippi.\nobb.usda.poverty_area_measures(edition='2025', state='MS', provider='usda')\n# Get the 2025-edition census-tract poverty-area measures for Mississippi.\nobb.usda.poverty_area_measures(edition='2025', level='tract', state='MS', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "edition", + "type": "str | None", + "description": "Published edition to retrieve. Each edition is a separate release of the poverty-area classification, differing in census-tract geography, metro/Beale/RUCA vintage, and the most recent ACS measurement periods carried. Valid editions are:\n 2025, 2023, 2022", + "default": "2025", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Edition", + "value": "2025", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "September 2025", + "value": "2025" + }, + { + "label": "December 2023", + "value": "2023" + }, + { + "label": "November 2022", + "value": "2022" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "level", + "type": "str | None", + "description": "Geographic level of the lookup. 'county' returns one row per county FIPS reading the county classification flags; 'tract' returns one row per census tract reading the tract flags. Valid levels are: county, tract.", + "default": "county", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Geography Level", + "value": "county", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "County", + "value": "county" + }, + { + "label": "Census Tract", + "value": "tract" + } + ], + "style": { + "popupWidth": 240 + } + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state postal abbreviation to scope the rows to a single state. If None, returns every area in the edition. At tract level the state filter is the primary usability lever.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/poverty_area_measures_states", + "optionsParams": { + "edition": "$edition" + }, + "style": { + "popupWidth": 260 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "PovertyAreaMeasures", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "fips", + "type": "str", + "description": "Area FIPS code of the row, with leading zeros preserved: the five-digit county FIPS at the county level, or the eleven-digit census-tract FIPS at the tract level.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 130 + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "Two-letter state postal abbreviation.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 80 + } + } + }, + { + "name": "county_name", + "type": "str | None", + "description": "County name with its state, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "cellDataType": "text", + "pinned": "left", + "minWidth": 200 + } + } + }, + { + "name": "metro_nonmetro", + "type": "int | None", + "description": "Metro-nonmetro status of the county: 1 metropolitan, 0 nonmetropolitan, under the edition's metro definition vintage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Metro", + "cellDataType": "text" + } + } + }, + { + "name": "rucc_code", + "type": "int | None", + "description": "Rural-Urban Continuum (Beale) code of the county, 1 to 9, for the edition's Beale vintage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Beale (RUCC)", + "cellDataType": "text" + } + } + }, + { + "name": "region", + "type": "int | None", + "description": "Census region code: 1 Northeast, 2 Midwest, 3 South, 4 West.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Region", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "subregion", + "type": "int | None", + "description": "ERS subregion code, 1 to 9.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ERS Subregion", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "tract_fips", + "type": "str | None", + "description": "Eleven-digit census-tract FIPS code; populated at the tract level only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tract FIPS", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "tract", + "type": "str | None", + "description": "Census-tract number as published; populated at the tract level only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tract", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "tract_name", + "type": "str | None", + "description": "Census-tract name; populated at the tract level only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tract Name", + "cellDataType": "text", + "hide": true, + "minWidth": 200 + } + } + }, + { + "name": "ruca_code", + "type": "int | None", + "description": "Rural-Urban Commuting Area code of the tract for the edition's RUCA vintage; populated at the tract level only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RUCA", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "bna", + "type": "int | None", + "description": "Block-numbering-area flag: 1 if the tract is a block-numbering area; populated at the tract level only.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BNA Tract", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "high_poverty_1960", + "type": "int | None", + "description": "High-poverty flag for 1960: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 1960", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "high_poverty_1970", + "type": "int | None", + "description": "High-poverty flag for 1970: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 1970", + "cellDataType": "text" + } + } + }, + { + "name": "high_poverty_1980", + "type": "int | None", + "description": "High-poverty flag for 1980: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 1980", + "cellDataType": "text" + } + } + }, + { + "name": "high_poverty_1990", + "type": "int | None", + "description": "High-poverty flag for 1990: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 1990", + "cellDataType": "text" + } + } + }, + { + "name": "high_poverty_2000", + "type": "int | None", + "description": "High-poverty flag for 2000: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 2000", + "cellDataType": "text" + } + } + }, + { + "name": "high_poverty_2007_11", + "type": "int | None", + "description": "High-poverty flag for the 2007-11 ACS period: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 2007-11", + "cellDataType": "text" + } + } + }, + { + "name": "high_poverty_2015_19", + "type": "int | None", + "description": "High-poverty flag for the 2015-19 ACS period: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available. Present in the 2022 and 2023 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 2015-19", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "high_poverty_2017_21", + "type": "int | None", + "description": "High-poverty flag for the 2017-21 ACS period: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available. Present in the 2023 and 2025 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 2017-21", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "high_poverty_2018_22", + "type": "int | None", + "description": "High-poverty flag for the 2018-22 ACS period: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available. Present in the 2025 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 2018-22", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "high_poverty_2019_23", + "type": "int | None", + "description": "High-poverty flag for the 2019-23 ACS period: 1 if the poverty rate was 20 percent or higher, 0 if below, -1 if not available. Present in the 2025 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "High Poverty 2019-23", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "extreme_poverty_1960", + "type": "int | None", + "description": "Extreme-poverty flag for 1960: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 1960", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "extreme_poverty_1970", + "type": "int | None", + "description": "Extreme-poverty flag for 1970: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 1970", + "cellDataType": "text" + } + } + }, + { + "name": "extreme_poverty_1980", + "type": "int | None", + "description": "Extreme-poverty flag for 1980: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 1980", + "cellDataType": "text" + } + } + }, + { + "name": "extreme_poverty_1990", + "type": "int | None", + "description": "Extreme-poverty flag for 1990: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 1990", + "cellDataType": "text" + } + } + }, + { + "name": "extreme_poverty_2000", + "type": "int | None", + "description": "Extreme-poverty flag for 2000: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 2000", + "cellDataType": "text" + } + } + }, + { + "name": "extreme_poverty_2007_11", + "type": "int | None", + "description": "Extreme-poverty flag for the 2007-11 ACS period: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 2007-11", + "cellDataType": "text" + } + } + }, + { + "name": "extreme_poverty_2015_19", + "type": "int | None", + "description": "Extreme-poverty flag for the 2015-19 ACS period: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available. Present in the 2022 and 2023 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 2015-19", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "extreme_poverty_2017_21", + "type": "int | None", + "description": "Extreme-poverty flag for the 2017-21 ACS period: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available. Present in the 2023 and 2025 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 2017-21", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "extreme_poverty_2018_22", + "type": "int | None", + "description": "Extreme-poverty flag for the 2018-22 ACS period: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available. Present in the 2025 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 2018-22", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "extreme_poverty_2019_23", + "type": "int | None", + "description": "Extreme-poverty flag for the 2019-23 ACS period: 1 if the poverty rate was 40 percent or higher, 0 if below, -1 if not available. Present in the 2025 edition.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Extreme Poverty 2019-23", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "persistent_poverty_1990", + "type": "int | None", + "description": "Persistent-poverty flag anchored at 1990: 1 if the poverty rate was 20 percent or higher across the four consecutive periods spanning roughly thirty years, 0 otherwise, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Poverty 1990", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "persistent_poverty_2000", + "type": "int | None", + "description": "Persistent-poverty flag anchored at 2000: 1 if the poverty rate was 20 percent or higher across the four consecutive periods spanning roughly thirty years, 0 otherwise, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Poverty 2000", + "cellDataType": "text" + } + } + }, + { + "name": "persistent_poverty_2007_11", + "type": "int | None", + "description": "Persistent-poverty flag anchored at the 2007-11 ACS period: 1 if the poverty rate was 20 percent or higher across the four consecutive periods spanning roughly thirty years, 0 otherwise, -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Poverty 2007-11", + "cellDataType": "text" + } + } + }, + { + "name": "persistent_poverty_2015_19", + "type": "int | None", + "description": "Persistent-poverty flag anchored at the 2015-19 ACS period: 1 if the poverty rate was 20 percent or higher across the four consecutive periods spanning roughly thirty years, 0 otherwise, -1 if not available. Present in the 2022 and 2023 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Poverty 2015-19", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "persistent_poverty_2017_21", + "type": "int | None", + "description": "Persistent-poverty flag anchored at the 2017-21 ACS period: 1 if the poverty rate was 20 percent or higher across the four consecutive periods spanning roughly thirty years, 0 otherwise, -1 if not available. Present in the 2023 and 2025 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Persistent Poverty 2017-21", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "enduring_poverty_2007_11", + "type": "int | None", + "description": "Enduring-poverty classification anchored at the 2007-11 ACS period: 0 not enduring, 1/2/3 enduring by the earliest qualifying decade (poverty 20 percent or higher across five or more consecutive periods over forty or more years), -1 if not available.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Enduring Poverty 2007-11", + "cellDataType": "text" + } + } + }, + { + "name": "enduring_poverty_2015_19", + "type": "int | None", + "description": "Enduring-poverty classification anchored at the 2015-19 ACS period: 0 not enduring, 1/2/3 enduring by the earliest qualifying decade, -1 if not available. Present in the 2022 and 2023 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Enduring Poverty 2015-19", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "enduring_poverty_2017_21", + "type": "int | None", + "description": "Enduring-poverty classification anchored at the 2017-21 ACS period: 0 not enduring, 1/2/3 enduring by the earliest qualifying decade, -1 if not available. Present in the 2023 and 2025 editions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Enduring Poverty 2017-21", + "cellDataType": "text", + "hide": true + } + } + } + ] + }, + "model": "PovertyAreaMeasures", + "openapi_extra": { + "model": "PovertyAreaMeasures" + } + }, + "/usda/area_road_ruggedness_states": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the states an area and road ruggedness scales vintage publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "vintage", + "type": "str", + "description": "Vintage key. Unknown vintages fall back to the latest vintage.", + "default": "2020", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/area_and_road_ruggedness_scales": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS area and road ruggedness scales - census-tract Area Ruggedness Scale (ARS) and Road Ruggedness Scale (RRS) classifications with terrain ruggedness statistics, rurality, and population, as a single-vintage geographic lookup table scoped by State.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.area_and_road_ruggedness_scales(provider='usda')\n# Get the 2020 area and road ruggedness scales for Colorado census tracts.\nobb.usda.area_and_road_ruggedness_scales(vintage='2020', state='CO', provider='usda')\n# Get the 2010 vintage for West Virginia census tracts.\nobb.usda.area_and_road_ruggedness_scales(vintage='2010', state='WV', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "vintage", + "type": "str | None", + "description": "Census-tract vintage to retrieve, selecting the source file. Each vintage is a separate census-tract lookup carrying the Area Ruggedness Scale (ARS) and Road Ruggedness Scale (RRS) classifications and their terrain statistics. Valid vintages are:\n 2020, 2010", + "default": "2020", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Vintage", + "value": "2020", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2020", + "value": "2020" + }, + { + "label": "2010", + "value": "2010" + } + ] + } + } + }, + { + "name": "state", + "type": "str | None", + "description": "State to retrieve, as a two-letter postal abbreviation. The census-tract lookup carries tens of thousands of rows, so the state is the primary scope filter. If None, defaults to West Virginia.", + "default": "WV", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "value": "WV", + "optionsEndpoint": "/api/v1/usda/area_road_ruggedness_states", + "optionsParams": { + "vintage": "$vintage" + }, + "style": { + "popupWidth": 280 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "AreaAndRoadRuggednessScales", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "tract_fips", + "type": "str", + "description": "Eleven-digit census-tract FIPS code, with leading zeros preserved.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tract FIPS", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 140 + } + } + }, + { + "name": "tract_name", + "type": "str | None", + "description": "Census-tract name, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Tract Name", + "cellDataType": "text", + "hide": true + } + } + }, + { + "name": "county_fips", + "type": "str | None", + "description": "Five-digit county FIPS code, with leading zeros preserved.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County FIPS", + "cellDataType": "text", + "hide": true, + "maxWidth": 120 + } + } + }, + { + "name": "county_name", + "type": "str | None", + "description": "County or county-equivalent area name, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "County", + "cellDataType": "text", + "pinned": "left", + "minWidth": 180 + } + } + }, + { + "name": "state_fips", + "type": "str | None", + "description": "Two-digit state FIPS code, with a leading zero preserved.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State FIPS", + "cellDataType": "text", + "hide": true, + "maxWidth": 110 + } + } + }, + { + "name": "state", + "type": "str", + "description": "Two-letter state or district postal code.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "state_name", + "type": "str | None", + "description": "Full state or district name.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State Name", + "cellDataType": "text", + "pinned": "left", + "minWidth": 150 + } + } + }, + { + "name": "rs_region", + "type": "str | None", + "description": "Ruggedness-Scale region code, 1 to 12.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RS Region", + "cellDataType": "text", + "hide": true, + "maxWidth": 110 + } + } + }, + { + "name": "rs_region_name", + "type": "str | None", + "description": "Ruggedness-Scale region name, one of the twelve regions the ARS and RRS thresholds are calibrated within.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RS Region Name", + "cellDataType": "text", + "minWidth": 180 + } + } + }, + { + "name": "primary_ruca", + "type": "str | None", + "description": "Primary Rural-Urban Commuting Area (RUCA) code, 1 to 10, with 99 marking a water tract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Primary RUCA", + "cellDataType": "text", + "hide": true, + "maxWidth": 120 + } + } + }, + { + "name": "rurality_code", + "type": "str | None", + "description": "Rurality code, 1 to 3, with 99 marking a tract without a rurality code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rurality Code", + "cellDataType": "text", + "hide": true, + "maxWidth": 120 + } + } + }, + { + "name": "rurality_name", + "type": "str | None", + "description": "Rurality name: Urbanized area, Urban commuting, Rural, or no rurality code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Rurality", + "cellDataType": "text", + "minWidth": 150 + } + } + }, + { + "name": "population", + "type": "int | None", + "description": "Census-tract population, as a full count.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Population", + "cellDataType": "number", + "maxWidth": 130 + } + } + }, + { + "name": "land_area", + "type": "float | None", + "description": "Census-tract land area, in square miles.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Land Area (sq mi)", + "cellDataType": "number" + } + } + }, + { + "name": "pop_density", + "type": "float | None", + "description": "Population density, in persons per square mile.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pop. Density", + "cellDataType": "number" + } + } + }, + { + "name": "area_tri_count", + "type": "int | None", + "description": "Count of terrain ruggedness index (TRI) grid cells summed over the tract's area.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Count", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "area_tri_mean", + "type": "float | None", + "description": "Mean area terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Mean", + "cellDataType": "number" + } + } + }, + { + "name": "area_tri_std_dev", + "type": "float | None", + "description": "Standard deviation of the area terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Std Dev", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "area_tri_median", + "type": "float | None", + "description": "Median area terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Median", + "cellDataType": "number" + } + } + }, + { + "name": "area_tri_min", + "type": "float | None", + "description": "Minimum area terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Min", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "area_tri_max", + "type": "float | None", + "description": "Maximum area terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Max", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "area_tri_range", + "type": "float | None", + "description": "Range of the area terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Area TRI Range", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "ars", + "type": "str | None", + "description": "Area Ruggedness Scale code, 1 to 6, from 1 Level to 6 Extremely rugged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARS", + "cellDataType": "text", + "maxWidth": 90 + } + } + }, + { + "name": "ars_description", + "type": "str | None", + "description": "Area Ruggedness Scale description for the code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ARS Description", + "cellDataType": "text", + "minWidth": 160 + } + } + }, + { + "name": "road_tri_count", + "type": "int | None", + "description": "Count of terrain ruggedness index (TRI) grid cells sampled along the tract's roads.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Count", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "road_tri_mean", + "type": "float | None", + "description": "Mean road terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Mean", + "cellDataType": "number" + } + } + }, + { + "name": "road_tri_std_dev", + "type": "float | None", + "description": "Standard deviation of the road terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Std Dev", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "road_tri_median", + "type": "float | None", + "description": "Median road terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Median", + "cellDataType": "number" + } + } + }, + { + "name": "road_tri_min", + "type": "float | None", + "description": "Minimum road terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Min", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "road_tri_max", + "type": "float | None", + "description": "Maximum road terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Max", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "road_tri_range", + "type": "float | None", + "description": "Range of the road terrain ruggedness index over the tract, in meters.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Road TRI Range", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "rrs", + "type": "str | None", + "description": "Road Ruggedness Scale code, 1 to 5, from 1 Level to 5 Highly rugged.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RRS", + "cellDataType": "text", + "maxWidth": 90 + } + } + }, + { + "name": "rrs_description", + "type": "str | None", + "description": "Road Ruggedness Scale description for the code.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "RRS Description", + "cellDataType": "text", + "minWidth": 160 + } + } + } + ] + }, + "model": "AreaAndRoadRuggednessScales", + "openapi_extra": { + "model": "AreaAndRoadRuggednessScales" + } + }, + "/usda/cost_estimates_of_foodborne_illnesses": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Cost Estimates of Foodborne Illnesses - annual cases and the economic burden of major foodborne pathogens, by pathogen and by health outcome, in 2023 U.S. dollars.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.cost_estimates_of_foodborne_illnesses(provider='usda')\n# Get the mean cost of each health outcome, by pathogen.\nobb.usda.cost_estimates_of_foodborne_illnesses(table='health_outcome_cost', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Cost-estimates table to retrieve. Each table is already one row per pathogen, with its cost measures spread across the value columns; pathogen classification and pathogen stay as pinned row columns. Valid tables are:\n cases_and_cost, health_outcome_cost", + "default": "cases_and_cost", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "cases_and_cost", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Cases, total cost, and per-case cost, by pathogen", + "value": "cases_and_cost" + }, + { + "label": "Mean cost for specific health outcomes, by pathogen", + "value": "health_outcome_cost" + } + ], + "style": { + "popupWidth": 480 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CostEstimatesOfFoodborneIllnesses", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "pathogen_classification", + "type": "str", + "description": "Pathogen classification, as published: 'Bacteria', 'Parasites', 'Viruses', or an aggregate row's grouping such as 'Illnesses from major foodborne pathogens', 'Other foodborne gastroenteritis', or 'All pathogens'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Classification", + "pinned": "left" + } + } + }, + { + "name": "pathogen", + "type": "str", + "description": "Pathogen name, as published, e.g. 'Campylobacter spp.', or an aggregate row label such as 'Subtotal' or 'Total'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Pathogen", + "pinned": "left" + } + } + } + ] + }, + "model": "CostEstimatesOfFoodborneIllnesses", + "openapi_extra": { + "model": "CostEstimatesOfFoodborneIllnesses" + } + }, + "/usda/snap_policy_data_sets": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS SNAP policy data sets - a selected State's monthly SNAP policy options from January 1996 to December 2020, with the forty-five broad-based categorical eligibility, recertification period, EBT issuance, interview-waiver, fingerprinting, noncitizen eligibility, online application, outreach spending, and vehicle-asset variables laid out as columns.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.snap_policy_data_sets(provider='usda')\n# Get California SNAP policy variables since 2010.\nobb.usda.snap_policy_data_sets(state='CA', start_year=2010, provider='usda')\n# Get Texas SNAP policy variables for 2019.\nobb.usda.snap_policy_data_sets(state='TX', start_year=2019, end_year=2019, provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "state", + "type": "str | None", + "description": "State to retrieve, as a two-letter postal code. The SNAP Policy Database is published for the fifty states and the District of Columbia; each state is one monthly time series of its forty-five policy variables.", + "default": "CA", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "State", + "value": "CA", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Alabama", + "value": "AL" + }, + { + "label": "Alaska", + "value": "AK" + }, + { + "label": "Arizona", + "value": "AZ" + }, + { + "label": "Arkansas", + "value": "AR" + }, + { + "label": "California", + "value": "CA" + }, + { + "label": "Colorado", + "value": "CO" + }, + { + "label": "Connecticut", + "value": "CT" + }, + { + "label": "Delaware", + "value": "DE" + }, + { + "label": "District of Columbia", + "value": "DC" + }, + { + "label": "Florida", + "value": "FL" + }, + { + "label": "Georgia", + "value": "GA" + }, + { + "label": "Hawaii", + "value": "HI" + }, + { + "label": "Idaho", + "value": "ID" + }, + { + "label": "Illinois", + "value": "IL" + }, + { + "label": "Indiana", + "value": "IN" + }, + { + "label": "Iowa", + "value": "IA" + }, + { + "label": "Kansas", + "value": "KS" + }, + { + "label": "Kentucky", + "value": "KY" + }, + { + "label": "Louisiana", + "value": "LA" + }, + { + "label": "Maine", + "value": "ME" + }, + { + "label": "Maryland", + "value": "MD" + }, + { + "label": "Massachusetts", + "value": "MA" + }, + { + "label": "Michigan", + "value": "MI" + }, + { + "label": "Minnesota", + "value": "MN" + }, + { + "label": "Mississippi", + "value": "MS" + }, + { + "label": "Missouri", + "value": "MO" + }, + { + "label": "Montana", + "value": "MT" + }, + { + "label": "Nebraska", + "value": "NE" + }, + { + "label": "Nevada", + "value": "NV" + }, + { + "label": "New Hampshire", + "value": "NH" + }, + { + "label": "New Jersey", + "value": "NJ" + }, + { + "label": "New Mexico", + "value": "NM" + }, + { + "label": "New York", + "value": "NY" + }, + { + "label": "North Carolina", + "value": "NC" + }, + { + "label": "North Dakota", + "value": "ND" + }, + { + "label": "Ohio", + "value": "OH" + }, + { + "label": "Oklahoma", + "value": "OK" + }, + { + "label": "Oregon", + "value": "OR" + }, + { + "label": "Pennsylvania", + "value": "PA" + }, + { + "label": "Rhode Island", + "value": "RI" + }, + { + "label": "South Carolina", + "value": "SC" + }, + { + "label": "South Dakota", + "value": "SD" + }, + { + "label": "Tennessee", + "value": "TN" + }, + { + "label": "Texas", + "value": "TX" + }, + { + "label": "Utah", + "value": "UT" + }, + { + "label": "Vermont", + "value": "VT" + }, + { + "label": "Virginia", + "value": "VA" + }, + { + "label": "Washington", + "value": "WA" + }, + { + "label": "West Virginia", + "value": "WV" + }, + { + "label": "Wisconsin", + "value": "WI" + }, + { + "label": "Wyoming", + "value": "WY" + } + ], + "style": { + "popupWidth": 280 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data. If None, returns from January 1996.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data. If None, returns through December 2020.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "SnapPolicyDataSets", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "date", + "type": "date | str", + "description": "First day of the observation month.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Date", + "cellDataType": "date", + "pinned": "left", + "maxWidth": 120 + } + } + }, + { + "name": "state", + "type": "str", + "description": "Name of the state of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "State", + "hide": true + } + } + }, + { + "name": "bbce", + "type": "float | None", + "description": "Whether the state uses broad-based categorical eligibility (BBCE): 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Uses BBCE", + "cellDataType": "number" + } + } + }, + { + "name": "bbce_asset", + "type": "float | None", + "description": "BBCE asset test: 0 = asset limit raised but not eliminated, 1 = asset limit eliminated. Blank when the state does not use BBCE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BBCE asset test (0=raised, 1=eliminated)", + "cellDataType": "number" + } + } + }, + { + "name": "bbce_a_amt", + "type": "float | None", + "description": "BBCE asset limit in thousands of dollars. Blank when the state does not use BBCE or BBCE eliminates the asset test; applies to only the few states that keep an asset limit, so hidden by default.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BBCE asset limit ($000)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "bbce_a_veh", + "type": "float | None", + "description": "BBCE vehicle rule: 1 = exempt an amount, 2 = exclude at least one, 3 = exclude all. Blank when the state does not use BBCE or the asset test is eliminated; applies to only the few states that keep an asset limit, so hidden by default.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BBCE vehicle rule (1=amount, 2=one, 3=all)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "bbce_inclmt", + "type": "float | None", + "description": "BBCE gross income limit as a percentage of the Federal poverty level. Blank when the state does not use BBCE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BBCE gross income limit (% FPL)", + "cellDataType": "number" + } + } + }, + { + "name": "bbce_child", + "type": "float | None", + "description": "Whether BBCE is limited to households with dependent children: 0 = no, 1 = yes. Blank when the state does not use BBCE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BBCE limited to households with children", + "cellDataType": "number" + } + } + }, + { + "name": "bbce_elddisinclmt", + "type": "float | None", + "description": "BBCE gross income limit (% FPL) for households with a senior or disabled member; -8 = gross income test eliminated, -7 = 200% FPL only for all-senior/disabled households. Blank when the state does not use BBCE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "BBCE elderly/disabled income limit (% FPL)", + "cellDataType": "number" + } + } + }, + { + "name": "bbce_multiple", + "type": "float | None", + "description": "Whether multiple BBCE guidelines apply to different household types: 0 = no, 1 = yes. Blank when the state does not use BBCE.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Multiple BBCE guidelines", + "cellDataType": "number" + } + } + }, + { + "name": "call_any", + "type": "float | None", + "description": "Whether the state operates call centers in any part of the state: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Call centers", + "cellDataType": "number" + } + } + }, + { + "name": "cap", + "type": "float | None", + "description": "Whether the state operates a Combined Application Project for SSI recipients: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "SSI Combined Application Project", + "cellDataType": "number" + } + } + }, + { + "name": "certearn_0103", + "type": "float | None", + "description": "Proportion of SNAP units with earnings with 1-3 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, earners 1-3 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certearn_0406", + "type": "float | None", + "description": "Proportion of SNAP units with earnings with 4-6 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, earners 4-6 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certearn_0712", + "type": "float | None", + "description": "Proportion of SNAP units with earnings with 7-12 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, earners 7-12 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certearn_1399", + "type": "float | None", + "description": "Proportion of SNAP units with earnings with 13+ month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, earners 13+ mo", + "cellDataType": "number" + } + } + }, + { + "name": "certearnavg", + "type": "float | None", + "description": "Average recertification period in months for SNAP units with earnings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Avg recert months, earners", + "cellDataType": "number" + } + } + }, + { + "name": "certearnmed", + "type": "float | None", + "description": "Median recertification period in months for SNAP units with earnings.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Median recert months, earners", + "cellDataType": "number" + } + } + }, + { + "name": "certeld_0103", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and a senior member with 1-3 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings w/ senior 1-3 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certeld_0406", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and a senior member with 4-6 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings w/ senior 4-6 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certeld_0712", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and a senior member with 7-12 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings w/ senior 7-12 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certeld_1399", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and a senior member with 13+ month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings w/ senior 13+ mo", + "cellDataType": "number" + } + } + }, + { + "name": "certeldavg", + "type": "float | None", + "description": "Average recertification period in months for SNAP units with no earnings and a senior member.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Avg recert months, no earnings w/ senior", + "cellDataType": "number" + } + } + }, + { + "name": "certeldmed", + "type": "float | None", + "description": "Median recertification period in months for SNAP units with no earnings and a senior member.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Median recert months, no earnings w/ senior", + "cellDataType": "number" + } + } + }, + { + "name": "certnonearn_0103", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and no senior member with 1-3 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings no senior 1-3 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certnonearn_0406", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and no senior member with 4-6 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings no senior 4-6 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certnonearn_0712", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and no senior member with 7-12 month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings no senior 7-12 mo", + "cellDataType": "number" + } + } + }, + { + "name": "certnonearn_1399", + "type": "float | None", + "description": "Proportion of SNAP units with no earnings and no senior member with 13+ month recertification periods.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Recert share, no earnings no senior 13+ mo", + "cellDataType": "number" + } + } + }, + { + "name": "certnonearnavg", + "type": "float | None", + "description": "Average recertification period in months for SNAP units with no earnings and no senior member.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Avg recert months, no earnings no senior", + "cellDataType": "number" + } + } + }, + { + "name": "certnonearnmed", + "type": "float | None", + "description": "Median recertification period in months for SNAP units with no earnings and no senior member.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Median recert months, no earnings no senior", + "cellDataType": "number" + } + } + }, + { + "name": "ebtissuance", + "type": "float | None", + "description": "Proportion of the dollar value of all SNAP benefits issued via electronic benefit transfer (EBT).", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Share of benefits via EBT", + "cellDataType": "number" + } + } + }, + { + "name": "faceini", + "type": "float | None", + "description": "Whether the state has a waiver to use a telephone interview at initial certification: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Telephone-interview waiver at initial cert", + "cellDataType": "number" + } + } + }, + { + "name": "facerec", + "type": "float | None", + "description": "Whether the state has a waiver to use a telephone interview at recertification: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Telephone-interview waiver at recert", + "cellDataType": "number" + } + } + }, + { + "name": "fingerprint", + "type": "float | None", + "description": "Whether the state requires fingerprinting of applicants: 0 = no, 1 = statewide, 2 = select parts of the state.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Fingerprinting (0=no, 1=statewide, 2=partial)", + "cellDataType": "number" + } + } + }, + { + "name": "noncitadultfull", + "type": "float | None", + "description": "Whether all legal noncitizen adults meeting other requirements are eligible: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Noncitizen adults eligible (full)", + "cellDataType": "number" + } + } + }, + { + "name": "noncitadultpart", + "type": "float | None", + "description": "Whether some, but not all, legal noncitizen adults meeting other requirements are eligible: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Noncitizen adults eligible (partial)", + "cellDataType": "number" + } + } + }, + { + "name": "noncitchildfull", + "type": "float | None", + "description": "Whether all legal noncitizen children meeting other requirements are eligible: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Noncitizen children eligible (full)", + "cellDataType": "number" + } + } + }, + { + "name": "noncitchildpart", + "type": "float | None", + "description": "Whether some, but not all, legal noncitizen children meeting other requirements are eligible: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Noncitizen children eligible (partial)", + "cellDataType": "number" + } + } + }, + { + "name": "nonciteldfull", + "type": "float | None", + "description": "Whether all legal noncitizen seniors meeting other requirements are eligible: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Noncitizen seniors eligible (full)", + "cellDataType": "number" + } + } + }, + { + "name": "nonciteldpart", + "type": "float | None", + "description": "Whether some, but not all, legal noncitizen seniors meeting other requirements are eligible: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Noncitizen seniors eligible (partial)", + "cellDataType": "number" + } + } + }, + { + "name": "oapp", + "type": "float | None", + "description": "Whether the state allows online SNAP applications: 0 = no, 1 = statewide, 2 = select parts of the state.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Online application (0=no, 1=statewide, 2=partial)", + "cellDataType": "number" + } + } + }, + { + "name": "outreach", + "type": "float | None", + "description": "Sum of Federal, State, and grant outreach spending in nominal thousands of dollars, spread across the fiscal year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Outreach spending ($000, nominal)", + "cellDataType": "number" + } + } + }, + { + "name": "reportsimple", + "type": "float | None", + "description": "Whether the state uses simplified reporting for households with earnings: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Simplified reporting", + "cellDataType": "number" + } + } + }, + { + "name": "transben", + "type": "float | None", + "description": "Whether the state offers transitional SNAP benefits to families leaving cash assistance: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Transitional benefits", + "cellDataType": "number" + } + } + }, + { + "name": "vehexclall", + "type": "float | None", + "description": "Whether the state excludes all vehicles from the asset test: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vehicle: exclude all", + "cellDataType": "number" + } + } + }, + { + "name": "vehexclamt", + "type": "float | None", + "description": "Whether the state exempts an amount above the standard auto exemption from a vehicle's value: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vehicle: exempt amount", + "cellDataType": "number" + } + } + }, + { + "name": "vehexclone", + "type": "float | None", + "description": "Whether the state excludes at least one, but not all, vehicles from the asset test: 0 = no, 1 = yes.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Vehicle: exclude one", + "cellDataType": "number" + } + } + } + ] + }, + "model": "SnapPolicyDataSets", + "openapi_extra": { + "model": "SnapPolicyDataSets" + } + }, + "/usda/intl_baseline_attributes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the measures published for an international baseline commodity.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity name. Unknown commodities fall back to wheat's measures.", + "default": "Wheat", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/intl_baseline_countries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the countries and regions published for a baseline commodity.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "commodity", + "type": "str", + "description": "Commodity name. Unknown commodities fall back to wheat's areas.", + "default": "Wheat", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/usda/international_baseline_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS International Baseline Data - long-term projections of area, yield, production, supply, use, and trade for grains, oilseeds, cotton, and livestock, pivoted to a wide layout with the countries and regions as columns and the crop or calendar years as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.international_baseline_data(provider='usda')\n# Get projected corn exports by country and region since 2020.\nobb.usda.international_baseline_data(commodity='Corn', attribute='Exports', start_year=2020, provider='usda')\n# Get China's long-term wheat production projection.\nobb.usda.international_baseline_data(commodity='Wheat', attribute='Production', country='China', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "commodity", + "type": "str | None", + "description": "Commodity to retrieve. The commodity and measure select one projection series whose countries and regions spread into the wide columns while the years stay in the rows. Valid commodities are:\n Barley, Beef and veal, Corn, Cotton, Pork, Poultry, Rice, Sorghum, Soybean meal, Soybean oil, Soybeans, Wheat", + "default": "Wheat", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Commodity", + "value": "Wheat", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Barley", + "value": "Barley" + }, + { + "label": "Beef and veal", + "value": "Beef and veal" + }, + { + "label": "Corn", + "value": "Corn" + }, + { + "label": "Cotton", + "value": "Cotton" + }, + { + "label": "Pork", + "value": "Pork" + }, + { + "label": "Poultry", + "value": "Poultry" + }, + { + "label": "Rice", + "value": "Rice" + }, + { + "label": "Sorghum", + "value": "Sorghum" + }, + { + "label": "Soybean meal", + "value": "Soybean meal" + }, + { + "label": "Soybean oil", + "value": "Soybean oil" + }, + { + "label": "Soybeans", + "value": "Soybeans" + }, + { + "label": "Wheat", + "value": "Wheat" + } + ], + "style": { + "popupWidth": 260 + } + } + } + }, + { + "name": "attribute", + "type": "str | None", + "description": "Measure to spread into the country columns, e.g. 'Production', 'Exports', or 'Ending stocks'. The available measures depend on the commodity.", + "default": "Production", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "type": "endpoint", + "value": "Production", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/intl_baseline_attributes", + "optionsParams": { + "commodity": "$commodity" + }, + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "country", + "type": "str | None", + "description": "Filter to a single country or region column, e.g. 'China'. If None, every country and region is spread into the columns.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Country or region", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/usda/intl_baseline_countries", + "optionsParams": { + "commodity": "$commodity" + }, + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the first four digits of the crop or calendar year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the first four digits of the crop or calendar year. If None, returns through the last projection year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "InternationalBaselineData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "str", + "description": "Crop or calendar year of the observation, as published, e.g. '2024/25' for crops or '2024' for livestock.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "pinned": "left", + "maxWidth": 110 + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity of the selection, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Commodity", + "hide": true + } + } + }, + { + "name": "attribute", + "type": "str | None", + "description": "Measure spread into the country columns, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Measure", + "hide": true + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit shared by every value column for the selection, as published, e.g. 'Thousand metric tons'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + }, + { + "name": "year_type", + "type": "str | None", + "description": "Year basis of the selection: 'Crop year' for crops or 'Calendar year' for livestock.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year type", + "hide": true + } + } + }, + { + "name": "topic", + "type": "str | None", + "description": "Topic of the commodity: 'Crops' or 'Livestock'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Topic", + "hide": true + } + } + } + ] + }, + "model": "InternationalBaselineData", + "openapi_extra": { + "model": "InternationalBaselineData" + } + }, + "/usda/eating_and_health_module_atus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Eating and Health Module (ATUS) tables - time spent eating, drinking, in associated and secondary eating, preparing food, grocery shopping, and buying fast food, by demographic, food-security, and body-mass-index subgroups, each kept in its published wide layout for a selected survey release year.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.eating_and_health_module_atus(provider='usda')\n# Get the 2023 fast-food purchase frequency table.\nobb.usda.eating_and_health_module_atus(table='fast_food_purchases', year='2023', provider='usda')\n# Get 2022 food-related activity time by BMI group.\nobb.usda.eating_and_health_module_atus(table='activities_by_bmi_group', year='2022', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Eating and Health Module table to retrieve. Each table is a single survey-year snapshot whose published measure-by-sex-by-statistic series ship pre-spread as the wide value columns, while the two leading dimensions stay as pinned row columns. Valid tables are:\n eating_and_drinking_time, eating_time_by_subgroup, grocery_shopper_and_meal_preparer, fast_food_purchases, activities_by_grocery_responsibility, activities_by_meal_prep_responsibility, activities_by_food_security, activities_by_bmi_group", + "default": "eating_and_drinking_time", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "eating_and_drinking_time", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 1 - Eating and drinking, associated activities, and secondary eating time, age 15+ and 18+", + "value": "eating_and_drinking_time" + }, + { + "label": "Table 2 - Eating and drinking time by age bracket and metropolitan status", + "value": "eating_time_by_subgroup" + }, + { + "label": "Table 3 - Usual grocery shopper and usual meal preparer in the household", + "value": "grocery_shopper_and_meal_preparer" + }, + { + "label": "Table 4 - Fast-food purchases over the previous 7 days", + "value": "fast_food_purchases" + }, + { + "label": "Table 5 - Selected activities by grocery-shopping responsibility, age 18+", + "value": "activities_by_grocery_responsibility" + }, + { + "label": "Table 6 - Selected activities by meal-preparation responsibility, age 18+", + "value": "activities_by_meal_prep_responsibility" + }, + { + "label": "Table 7 - Selected food-related activities by food-security subgroups, age 18+", + "value": "activities_by_food_security" + }, + { + "label": "Table 8 - Selected food-related activities by BMI group, age 20+", + "value": "activities_by_bmi_group" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "year", + "type": "str | None", + "description": "Release year selecting which survey-year snapshot to load. Valid years are:\n 2023, 2022", + "default": "2023", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Release year", + "value": "2023", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "2023", + "value": "2023" + }, + { + "label": "2022", + "value": "2022" + } + ] + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "EatingAndHealthModuleAtus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "category", + "type": "str", + "description": "Leading survey dimension of the row, as published, e.g. the activity, response level, count of fast-food purchases, or BMI group.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Category", + "cellDataType": "text", + "pinned": "left" + } + } + }, + { + "name": "subgroup", + "type": "str", + "description": "Second survey dimension of the row, as published, e.g. the age bracket, metropolitan status, gender, or breakdown question.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Subgroup", + "cellDataType": "text", + "pinned": "left" + } + } + }, + { + "name": "measure_type", + "type": "str | None", + "description": "Whether the fast-food row is an average count or a percent of purchasers. Populated only for the fast-food purchases table and null for every other table.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Number/percent", + "cellDataType": "text", + "pinned": "left", + "hide": true + } + } + } + ] + }, + "model": "EatingAndHealthModuleAtus", + "openapi_extra": { + "model": "EatingAndHealthModuleAtus" + } + }, + "/usda/food_consumption_nutrient_intakes_and_diet_quality": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS food consumption, nutrient intakes, and diet quality - U.S. daily nutrient and food-group intake, share, and density by food source, population-subgroup sample sizes, and 2020-2025 recommended densities, from 1977 to 2018, each pivoted to a wide layout by survey cycle (Tables 1-7) or recommended-vs-actual density (Table 8).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.food_consumption_nutrient_intakes_and_diet_quality(provider='usda')\n# Get daily nutrient intake by food source for males.\nobb.usda.food_consumption_nutrient_intakes_and_diet_quality(table='2_nutrient_intake', demographics='Sex - Males', provider='usda')\n# Get the standard error of the mean for the food-group intake shares since 2003.\nobb.usda.food_consumption_nutrient_intakes_and_diet_quality(table='6_food_group_intake_share', statistic='se_of_mean', start_year=2003, provider='usda')\n# Get the 2020-2025 recommended versus 2017-2018 actual nutrient and food-group densities.\nobb.usda.food_consumption_nutrient_intakes_and_diet_quality(table='8_recommended_vs_actual_density', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Table to retrieve. Tables 1-7 are a 1977-2018 survey-cycle series, pivoted with the survey cycles as columns; Table 8 pivots the recommended and 2017-2018 actual densities into columns. Valid tables are:\n 1_sample_sizes, 2_nutrient_intake, 3_nutrient_intake_share, 4_nutrient_density, 5_food_group_intake, 6_food_group_intake_share, 7_food_group_density, 8_recommended_vs_actual_density", + "default": "2_nutrient_intake", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "value": "2_nutrient_intake", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Table 1 - Sample sizes by population subgroup", + "value": "1_sample_sizes" + }, + { + "label": "Table 2 - Daily nutrient intake by food source", + "value": "2_nutrient_intake" + }, + { + "label": "Table 3 - Daily nutrient intake and share by food source", + "value": "3_nutrient_intake_share" + }, + { + "label": "Table 4 - Nutrient density by food source", + "value": "4_nutrient_density" + }, + { + "label": "Table 5 - Food group intake by food source", + "value": "5_food_group_intake" + }, + { + "label": "Table 6 - Food group intake and share by food source", + "value": "6_food_group_intake_share" + }, + { + "label": "Table 7 - Food group density by food source", + "value": "7_food_group_density" + }, + { + "label": "Table 8 - Recommended vs. actual density (2017-2018)", + "value": "8_recommended_vs_actual_density" + } + ], + "style": { + "popupWidth": 460 + } + } + } + }, + { + "name": "demographics", + "type": "str | None", + "description": "Population subgroup filter for the intake tables (2-7), keeping the survey-cycle columns to a single subgroup. Ignored by the sample-size table (1), which lists every subgroup, and by the recommended-density table (8). Valid subgroups are:\n US consumers aged 2 and above, Sex - Males, Sex - Females, Ages 2-19, Ages 20-64, Ages 65 and above, Cohort - Boys age 2-19, Cohort - Girls age 2-19, Cohort - Men age 20 and above, Cohort - Women age 20 and above, Income - low-income households, Income - mid-income households, Income - high-income households, Race - Non-Hispanic White, Race - Non-Hispanic Black, Race - Hispanic, Race - Other racial & ethnic, Edu. - Less than high school, Edu. - High school degree, Edu. - College attended", + "default": "US consumers aged 2 and above", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Demographic subgroup", + "value": "US consumers aged 2 and above", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "US consumers aged 2 and above", + "value": "US consumers aged 2 and above" + }, + { + "label": "Sex - Males", + "value": "Sex - Males" + }, + { + "label": "Sex - Females", + "value": "Sex - Females" + }, + { + "label": "Ages 2-19", + "value": "Ages 2-19" + }, + { + "label": "Ages 20-64", + "value": "Ages 20-64" + }, + { + "label": "Ages 65 and above", + "value": "Ages 65 and above" + }, + { + "label": "Cohort - Boys age 2-19", + "value": "Cohort - Boys age 2-19" + }, + { + "label": "Cohort - Girls age 2-19", + "value": "Cohort - Girls age 2-19" + }, + { + "label": "Cohort - Men age 20 and above", + "value": "Cohort - Men age 20 and above" + }, + { + "label": "Cohort - Women age 20 and above", + "value": "Cohort - Women age 20 and above" + }, + { + "label": "Income - low-income households", + "value": "Income - low-income households" + }, + { + "label": "Income - mid-income households", + "value": "Income - mid-income households" + }, + { + "label": "Income - high-income households", + "value": "Income - high-income households" + }, + { + "label": "Race - Non-Hispanic White", + "value": "Race - Non-Hispanic White" + }, + { + "label": "Race - Non-Hispanic Black", + "value": "Race - Non-Hispanic Black" + }, + { + "label": "Race - Hispanic", + "value": "Race - Hispanic" + }, + { + "label": "Race - Other racial & ethnic", + "value": "Race - Other racial & ethnic" + }, + { + "label": "Edu. - Less than high school", + "value": "Edu. - Less than high school" + }, + { + "label": "Edu. - High school degree", + "value": "Edu. - High school degree" + }, + { + "label": "Edu. - College attended", + "value": "Edu. - College attended" + } + ], + "style": { + "popupWidth": 360 + } + } + } + }, + { + "name": "statistic", + "type": "str | None", + "description": "Statistic to spread across the survey-cycle columns for the intake tables (2-7): the mean, or the standard error of the mean. Ignored by the sample-size and recommended-density tables. Valid statistics are:\n mean, se_of_mean", + "default": "mean", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Statistic", + "value": "mean", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Mean", + "value": "mean" + }, + { + "label": "SE of mean", + "value": "se_of_mean" + } + ] + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the survey-cycle columns, compared against the first year of each cycle. Ignored by the recommended-density table. If None, returns from 1977.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the survey-cycle columns, compared against the first year of each cycle. Ignored by the recommended-density table. If None, returns through 2017-2018.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "FoodConsumptionNutrientIntakesAndDietQuality", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "item", + "type": "str", + "description": "Row identity: the nutrient (Tables 2-4, 8), food group (Tables 5-8), or population subgroup (Table 1), as published. On the intake tables (2-7) the food source is appended, e.g. 'Energy \u2014 FAH', because each nutrient repeats once per food source.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Item", + "pinned": "left", + "minWidth": 260 + } + } + }, + { + "name": "food_source", + "type": "str | None", + "description": "Food source of the observation for the intake tables (2-7): Total, food at home (FAH), food away from home (FAFH), or an FAFH outlet. Already folded into the item label; kept as a separate toggleable column. None for the sample-size and recommended-density tables.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food source", + "pinned": "left", + "minWidth": 150, + "hide": true + } + } + }, + { + "name": "units", + "type": "str | None", + "description": "Unit of the row's values, as published, e.g. 'Calories', 'Grams', 'Percent of total', or 'Grams per 1,000 calories'. None for the sample-size table and where a unit is carried in the item label instead.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Units", + "pinned": "left", + "minWidth": 150, + "hide": true + } + } + } + ] + }, + "model": "FoodConsumptionNutrientIntakesAndDietQuality", + "openapi_extra": { + "model": "FoodConsumptionNutrientIntakesAndDietQuality" + } + }, + "/usda/resource_requirements_of_food_demand": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS resource requirements of food demand - the employment, freshwater withdrawals, and energy use, total and by source, embodied across the U.S. food supply chain to meet final consumer demand for each food, beverage, and food-related category, pivoted to a wide layout with the resource-and-source measures as columns and year and supply-chain stage as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.resource_requirements_of_food_demand(provider='usda')\n# Get the resources embodied in beef demand since 2015.\nobb.usda.resource_requirements_of_food_demand(table='Xf1103', start_year=2015, provider='usda')\n# Get the household home-kitchen and transportation resource use.\nobb.usda.resource_requirements_of_food_demand(table='Xf3000', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "table", + "type": "str | None", + "description": "Food group, commodity, or aggregate table to retrieve, identified by its Xf table number. Each table holds the employment, freshwater withdrawal, and energy resources embodied across the food supply chain to meet final demand for that category; the resource-and-source measures become the wide value columns while year and supply-chain stage stay as pinned rows. Valid tables are:\n Xf0000 (Food and food-related), Xf1000 (Food), Xf1100 (Food at home), Xf1101 (Cereals), Xf1102 (Bakery products), Xf1103 (Beef), Xf1104 (Pork), Xf1105 (Other meats), Xf1106 (Poultry), Xf1107 (Fish and seafood), Xf1108 (Fresh milk), Xf1109 (Processed dairy products), Xf1110 (Fresh eggs), Xf1111 (Processed eggs), Xf1112 (Fats and oils), Xf1113 (Fresh fruits), Xf1114 (Fresh vegetables), Xf1115 (Canned, frozen, and dried fruits and vegetables), Xf1116 (Sugar and sweets), Xf1117 (Snack foods), Xf1118 (Frozen prepared foods), Xf1119 (Processed fruit and vegetable canning and drying), Xf1120 (Seasonings, sauces, and dressings), Xf1121 (Dry, condensed, and evaporated dairy and non-dairy products), Xf1122 (Tree nuts and peanuts), Xf1123 (Fresh cut produce plus grab-and-go foods), Xf1124 (Miscellaneous foods and ingredients), Xf1125 (Fruit and vegetable juices), Xf1126 (Food consumed on farms), Xf1127 (Coffee, tea, and beverage materials), Xf1128 (Soft drinks and bottled water), Xf1200 (Food away from home), Xf1201 (Food at full-service restaurants), Xf1202 (Food at limited-service restaurants), Xf1203 (Food at other food and drinking places), Xf1204 (Food at schools and colleges), Xf1205 (Food furnished to employees (including military)), Xf1206 (Institutional and employer furnished meals plus food assistance), Xf1207 (Food and non-alcoholic beverages at work (per diem and expensing)), Xf2000 (Alcohol), Xf2100 (Alcohol at home), Xf2101 (Beer), Xf2102 (Wine), Xf2103 (Spirits), Xf2200 (Alcohol away from home), Xf2201 (Alcohol at full-service restaurants), Xf2202 (Alcohol at limited-service restaurants), Xf2203 (Alcohol at other food and drinking places), Xf3000 (Households)", + "default": "Xf0000", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Food group", + "value": "Xf0000", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Xf0000 - Food and food-related", + "value": "Xf0000" + }, + { + "label": "Xf1000 - Food", + "value": "Xf1000" + }, + { + "label": "Xf1100 - Food at home", + "value": "Xf1100" + }, + { + "label": "Xf1101 - Cereals", + "value": "Xf1101" + }, + { + "label": "Xf1102 - Bakery products", + "value": "Xf1102" + }, + { + "label": "Xf1103 - Beef", + "value": "Xf1103" + }, + { + "label": "Xf1104 - Pork", + "value": "Xf1104" + }, + { + "label": "Xf1105 - Other meats", + "value": "Xf1105" + }, + { + "label": "Xf1106 - Poultry", + "value": "Xf1106" + }, + { + "label": "Xf1107 - Fish and seafood", + "value": "Xf1107" + }, + { + "label": "Xf1108 - Fresh milk", + "value": "Xf1108" + }, + { + "label": "Xf1109 - Processed dairy products", + "value": "Xf1109" + }, + { + "label": "Xf1110 - Fresh eggs", + "value": "Xf1110" + }, + { + "label": "Xf1111 - Processed eggs", + "value": "Xf1111" + }, + { + "label": "Xf1112 - Fats and oils", + "value": "Xf1112" + }, + { + "label": "Xf1113 - Fresh fruits", + "value": "Xf1113" + }, + { + "label": "Xf1114 - Fresh vegetables", + "value": "Xf1114" + }, + { + "label": "Xf1115 - Canned, frozen, and dried fruits and vegetables", + "value": "Xf1115" + }, + { + "label": "Xf1116 - Sugar and sweets", + "value": "Xf1116" + }, + { + "label": "Xf1117 - Snack foods", + "value": "Xf1117" + }, + { + "label": "Xf1118 - Frozen prepared foods", + "value": "Xf1118" + }, + { + "label": "Xf1119 - Processed fruit and vegetable canning and drying", + "value": "Xf1119" + }, + { + "label": "Xf1120 - Seasonings, sauces, and dressings", + "value": "Xf1120" + }, + { + "label": "Xf1121 - Dry, condensed, and evaporated dairy and non-dairy products", + "value": "Xf1121" + }, + { + "label": "Xf1122 - Tree nuts and peanuts", + "value": "Xf1122" + }, + { + "label": "Xf1123 - Fresh cut produce plus grab-and-go foods", + "value": "Xf1123" + }, + { + "label": "Xf1124 - Miscellaneous foods and ingredients", + "value": "Xf1124" + }, + { + "label": "Xf1125 - Fruit and vegetable juices", + "value": "Xf1125" + }, + { + "label": "Xf1126 - Food consumed on farms", + "value": "Xf1126" + }, + { + "label": "Xf1127 - Coffee, tea, and beverage materials", + "value": "Xf1127" + }, + { + "label": "Xf1128 - Soft drinks and bottled water", + "value": "Xf1128" + }, + { + "label": "Xf1200 - Food away from home", + "value": "Xf1200" + }, + { + "label": "Xf1201 - Food at full-service restaurants", + "value": "Xf1201" + }, + { + "label": "Xf1202 - Food at limited-service restaurants", + "value": "Xf1202" + }, + { + "label": "Xf1203 - Food at other food and drinking places", + "value": "Xf1203" + }, + { + "label": "Xf1204 - Food at schools and colleges", + "value": "Xf1204" + }, + { + "label": "Xf1205 - Food furnished to employees (including military)", + "value": "Xf1205" + }, + { + "label": "Xf1206 - Institutional and employer furnished meals plus food assistance", + "value": "Xf1206" + }, + { + "label": "Xf1207 - Food and non-alcoholic beverages at work (per diem and expensing)", + "value": "Xf1207" + }, + { + "label": "Xf2000 - Alcohol", + "value": "Xf2000" + }, + { + "label": "Xf2100 - Alcohol at home", + "value": "Xf2100" + }, + { + "label": "Xf2101 - Beer", + "value": "Xf2101" + }, + { + "label": "Xf2102 - Wine", + "value": "Xf2102" + }, + { + "label": "Xf2103 - Spirits", + "value": "Xf2103" + }, + { + "label": "Xf2200 - Alcohol away from home", + "value": "Xf2200" + }, + { + "label": "Xf2201 - Alcohol at full-service restaurants", + "value": "Xf2201" + }, + { + "label": "Xf2202 - Alcohol at limited-service restaurants", + "value": "Xf2202" + }, + { + "label": "Xf2203 - Alcohol at other food and drinking places", + "value": "Xf2203" + }, + { + "label": "Xf3000 - Households", + "value": "Xf3000" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the beginning of the series.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns up to the most recent year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "ResourceRequirementsOfFoodDemand", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "int", + "description": "Year of the observation.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 90 + } + } + }, + { + "name": "stage", + "type": "str | None", + "description": "Supply-chain stage the resources are attributed to, as published, e.g. 'Total', 'Crops', 'Food retail', or a household home-kitchen stage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Supply chain stage", + "pinned": "left" + } + } + }, + { + "name": "employment", + "type": "float | None", + "description": "Full- or part-time employees per year embodied at the stage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Employment (employees/yr)", + "cellDataType": "number" + } + } + }, + { + "name": "water", + "type": "float | None", + "description": "Freshwater withdrawals embodied at the stage, in million gallons per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Water withdrawals (Mgal/yr)", + "cellDataType": "number" + } + } + }, + { + "name": "energy_total", + "type": "float | None", + "description": "Total energy from all sources embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Total (bBtu/yr)", + "cellDataType": "number" + } + } + }, + { + "name": "energy_pa", + "type": "float | None", + "description": "Energy from all petroleum products embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Petroleum products (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_ng", + "type": "float | None", + "description": "Energy from natural gas, including supplemental gaseous fuels, embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Natural gas (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_es", + "type": "float | None", + "description": "Energy from electricity sales embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Electricity sales (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_cl", + "type": "float | None", + "description": "Energy from coal embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Coal (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_lo", + "type": "float | None", + "description": "Electrical system energy losses embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Electrical system losses (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_bf", + "type": "float | None", + "description": "Energy from biofuel embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Biofuel (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_ww", + "type": "float | None", + "description": "Energy from wood and biomass waste embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Wood and biomass waste (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_wd", + "type": "float | None", + "description": "Energy from wood embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Wood (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_hy", + "type": "float | None", + "description": "Energy from hydroelectric power embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Hydroelectric (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_ge", + "type": "float | None", + "description": "Energy from geothermal power embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Geothermal (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_so", + "type": "float | None", + "description": "Energy from solar power embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Solar (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_wy", + "type": "float | None", + "description": "Energy from wind power embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Wind (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_cc", + "type": "float | None", + "description": "Energy from coal coke embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Coal coke (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + }, + { + "name": "energy_sf", + "type": "float | None", + "description": "Energy from supplemental gaseous fuels embodied at the stage, in billion British thermal units per year.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Energy: Supplemental gaseous fuels (bBtu/yr)", + "cellDataType": "number", + "hide": true + } + } + } + ] + }, + "model": "ResourceRequirementsOfFoodDemand", + "openapi_extra": { + "model": "ResourceRequirementsOfFoodDemand" + } + }, + "/usda/purchase_to_plate": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Purchase to Plate national average prices - estimated price per 100 edible grams for NHANES foods, pivoted to a price column per biennial survey cycle.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.purchase_to_plate(provider='usda')\n# Get national average prices for grain products.\nobb.usda.purchase_to_plate(food_group='grains', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "food_group", + "type": "str | None", + "description": "Food group to retrieve, derived from the FNDDS food-code leading digit. Valid food groups are:\n milk, meat, eggs, legumes, grains, fruits, vegetables, fats, sugars", + "default": "milk", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Food group", + "value": "milk", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Milk and milk products", + "value": "milk" + }, + { + "label": "Meat, poultry, fish, and mixtures", + "value": "meat" + }, + { + "label": "Eggs", + "value": "eggs" + }, + { + "label": "Legumes, nuts, and seeds", + "value": "legumes" + }, + { + "label": "Grain products", + "value": "grains" + }, + { + "label": "Fruits", + "value": "fruits" + }, + { + "label": "Vegetables", + "value": "vegetables" + }, + { + "label": "Fats, oils, and salad dressings", + "value": "fats" + }, + { + "label": "Sugars, sweets, and beverages", + "value": "sugars" + } + ], + "style": { + "popupWidth": 320 + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "PurchaseToPlate", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "food_code", + "type": "str", + "description": "Eight-digit FNDDS food code identifying the food item.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food code", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 130 + } + } + }, + { + "name": "mod_code", + "type": "str | None", + "description": "Recipe modification code, '0' for an unmodified item. Non-zero only on the 2011/2012 recipe-modification rows.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Modification code", + "hide": true + } + } + }, + { + "name": "food_description", + "type": "str", + "description": "Food description, as published in the most recent survey cycle the item appears in.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Food description", + "pinned": "left" + } + } + }, + { + "name": "method_description", + "type": "str | None", + "description": "Price-estimation method, as published in the most recent survey cycle the item appears in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Method", + "hide": true + } + } + }, + { + "name": "nhanes", + "type": "str | None", + "description": "NHANES reporting flag, as published in the most recent survey cycle the item appears in.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "NHANES", + "hide": true + } + } + }, + { + "name": "cycle_2011_2012", + "type": "float | None", + "description": "National average price for the 2011/2012 survey cycle, in nominal U.S. dollars per 100 edible grams.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2011/2012", + "cellDataType": "number" + } + } + }, + { + "name": "cycle_2013_2014", + "type": "float | None", + "description": "National average price for the 2013/2014 survey cycle, in nominal U.S. dollars per 100 edible grams.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2013/2014", + "cellDataType": "number" + } + } + }, + { + "name": "cycle_2015_2016", + "type": "float | None", + "description": "National average price for the 2015/2016 survey cycle, in nominal U.S. dollars per 100 edible grams.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2015/2016", + "cellDataType": "number" + } + } + }, + { + "name": "cycle_2017_2018", + "type": "float | None", + "description": "National average price for the 2017/2018 survey cycle, in nominal U.S. dollars per 100 edible grams.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "2017/2018", + "cellDataType": "number" + } + } + } + ] + }, + "model": "PurchaseToPlate", + "openapi_extra": { + "model": "PurchaseToPlate" + } + }, + "/usda/global_food_assessment": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ERS Global Food Assessment - grain food demand, other demand, total demand, production, and the implied additional supply required to close the food gap, pivoted to a wide layout with the subregions as columns and the base year and ten-year projection horizon as rows.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.global_food_assessment(provider='usda')\n# Get the implied additional grain supply required across Sub-Saharan Africa's subregions.\nobb.usda.global_food_assessment(element='Implied additional supply required', region='Sub-Saharan Africa', provider='usda')\n# Get grain production for the Middle East and North Africa.\nobb.usda.global_food_assessment(element='Grain production', region='Middle East and North Africa', provider='usda')\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "element", + "type": "str | None", + "description": "Measure to retrieve. The measure selects one series whose subregions spread into the wide columns while the base year and the ten-year projection horizon stay in the rows. Valid measures are:\n Food grain demand, Other grain demand, Grain production, Implied additional supply required, Total grain demand", + "default": "Total grain demand", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Measure", + "value": "Total grain demand", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Food grain demand", + "value": "Food grain demand" + }, + { + "label": "Other grain demand", + "value": "Other grain demand" + }, + { + "label": "Grain production", + "value": "Grain production" + }, + { + "label": "Implied additional supply required", + "value": "Implied additional supply required" + }, + { + "label": "Total grain demand", + "value": "Total grain demand" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "region", + "type": "str | None", + "description": "Filter to a single region's subregions, e.g. 'Sub-Saharan Africa'. If None, every subregion is spread into the columns. Valid regions are:\n Asia, Former Soviet Union, Latin America and the Caribbean, Middle East and North Africa, Sub-Saharan Africa, GFA countries", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Region", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Asia", + "value": "Asia" + }, + { + "label": "Former Soviet Union", + "value": "Former Soviet Union" + }, + { + "label": "Latin America and the Caribbean", + "value": "Latin America and the Caribbean" + }, + { + "label": "Middle East and North Africa", + "value": "Middle East and North Africa" + }, + { + "label": "Sub-Saharan Africa", + "value": "Sub-Saharan Africa" + }, + { + "label": "GFA countries", + "value": "GFA countries" + } + ], + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering the data, compared against the observation year. If None, returns from the base year.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Start year" + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering the data, compared against the observation year. If None, returns through the projection horizon.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "End year" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "GlobalFoodAssessment", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "usda": [ + { + "name": "year", + "type": "str", + "description": "Year of the observation: the base year or the ten-year projection horizon, e.g. '2025' or '2035'.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Year", + "cellDataType": "text", + "pinned": "left", + "maxWidth": 110 + } + } + }, + { + "name": "element", + "type": "str | None", + "description": "Measure spread into the subregion columns, as published.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Measure", + "hide": true + } + } + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit shared by every value column for the selection, as published in the source value-column header: 'Millions of metric tons'.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Unit", + "hide": true + } + } + } + ] + }, + "model": "GlobalFoodAssessment", + "openapi_extra": { + "model": "GlobalFoodAssessment" + } + }, + "/usda/psd_data": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get data tables and historical time series from the USDA FAS Production, Supply, and Distribution (PSD) Reports.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the World Crop Production Summary table.\nobb.usda.psd_data(provider='usda')\n# Get all attributes for Coffee globally, for a single year.\nobb.usda.psd_data(provider='usda', commodity='coffee', start_year=2025, end_year=2025)\n# Get historical production of corn in the US from 2020.\nobb.usda.psd_data(provider='usda', commodity='corn', country='united_states', attribute='production', start_year=2020)\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "report_id", + "type": "str | None", + "description": "Report ID to retrieve. Gets the current report for the given commodity and subject. These are predefined tables that are part of the PDF publication data. This parameter is ignored if 'commodity' is provided. Use the 'commodity' parameter for time series data. Valid reports are:\n almonds_summary, almonds_supply_distribution, apples_selected_countries, apples_supply_distribution, barley_area_yield_production, barley_regional, barley_supply_disappearance, barley_world_production_consumption_stocks, barley_world_trade, beef_veal_production, beef_veal_trade, butter_production_consumption, butter_trade, cattle_stocks, cattle_trade, cheese_production_consumption, cheese_trade, cherries_selected_countries, cherries_supply_distribution, chicken_production, chicken_trade, china_grain_supply_demand, coarse_grains_area_yield_production, coarse_grains_regional, coarse_grains_world_production_consumption_stocks, coarse_grains_world_trade, coffee_arabica_production, coffee_consumption, coffee_ending_stocks, coffee_exports_green_bean, coffee_exports_soluble, coffee_exports_total, coffee_imports_green_bean, coffee_imports_soluble, coffee_imports_total, coffee_production, coffee_robusta_production, coffee_summary, coffee_summary_2, coffee_summary_3, coffee_summary_4, copra_palm_kernel_palm_oil_production, corn_area_yield_production, corn_barley_supply_demand, corn_regional, corn_supply_disappearance, corn_world_production_consumption_stocks, corn_world_trade, cotton_area_yield_production, cotton_area_yield_production_fcr, cotton_by_country, cotton_by_country_2, cotton_foreign_supply, cotton_monthly_changes, cotton_supply_distribution, cotton_supply_distribution_2, cotton_us_supply, cotton_world_supply, cotton_world_supply_use, cotton_world_supply_use_2, cottonseed_area_yield_production, eu_grain_supply_demand, grains_summary_comparison, grapefruit_selected_countries, grapes_selected_countries, grapes_supply_distribution, lemons_limes_selected_countries, milk_cow_numbers, milk_production_consumption, nonfat_dry_milk_production_consumption, nonfat_dry_milk_trade, oats_area_yield_production, oats_regional, oats_world_production_consumption_stocks, oats_world_trade, oilseeds_area_yield_production, oilseeds_china, oilseeds_eu, oilseeds_india, oilseeds_middle_east, oilseeds_products_world_supply_demand, oilseeds_southeast_asia, oilseeds_us_supply_distribution, oilseeds_world_commodity_view, oilseeds_world_country_view, orange_juice_supply_distribution, oranges_selected_countries, oranges_selected_countries_2, other_europe_grain_supply_demand, palm_coconut_fishmeal_world_supply_demand, palm_oil_world_supply, peaches_nectarines_selected_countries, peaches_nectarines_supply_distribution, peanut_area_yield_production, pears_selected_countries, pears_supply_distribution, pistachios_summary, pistachios_supply_distribution, pork_production, pork_trade, protein_meals_world_commodity_view, protein_meals_world_country_view, raisins_selected_countries, raisins_supply_distribution, rapeseed_area_yield_production, rapeseed_products_world_supply, rapeseed_products_world_supply_demand, rice_area_yield_production, rice_regional, rice_supply_demand, rice_world_production_consumption_stocks, rice_world_trade, russia_barley, russia_corn, russia_grain_supply_demand, russia_wheat, rye_area_yield_production, rye_regional, rye_world_production_consumption_stocks, rye_world_trade, sorghum_area_yield_production, sorghum_regional, sorghum_supply_disappearance, sorghum_world_production_consumption_stocks, sorghum_world_trade, soybean_meal_world_supply, soybean_oil_world_supply, soybeans_area_yield_production, soybeans_argentina_supply_distribution, soybeans_brazil_supply_distribution, soybeans_products_world_supply_demand, soybeans_products_world_trade, soybeans_us_supply_distribution, soybeans_world_supply, sugar_ending_stocks, sugar_imports_exports, sugar_production_consumption, sunflower_area_yield_production, sunflower_products_world_supply, sunflower_products_world_supply_demand, swine_stocks, swine_trade, tangerines_mandarins_selected_countries, us_grains_supply_distribution, vegetable_oils_minor_world_supply, vegetable_oils_world_commodity_view, vegetable_oils_world_country_view, walnuts_summary, walnuts_supply_distribution, wheat_area_yield_production, wheat_coarse_grains_supply_demand, wheat_coarse_grains_world_supply_demand, wheat_flour_products_world_trade, wheat_regional, wheat_supply_disappearance, wheat_world_production_consumption_stocks, whole_milk_powder_production_consumption, whole_milk_powder_trade, world_crop_production_summary", + "default": "world_crop_production_summary", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "description": "Report ID to retrieve. Gets the current report for the given commodity and subject. Ignored if 'commodity' is provided.", + "value": "world_crop_production_summary", + "options": [ + { + "label": "Almonds Summary", + "value": "almonds_summary" + }, + { + "label": "Almonds Supply Distribution", + "value": "almonds_supply_distribution" + }, + { + "label": "Apples Selected Countries", + "value": "apples_selected_countries" + }, + { + "label": "Apples Supply Distribution", + "value": "apples_supply_distribution" + }, + { + "label": "Barley Area Yield Production", + "value": "barley_area_yield_production" + }, + { + "label": "Barley Regional", + "value": "barley_regional" + }, + { + "label": "Barley Supply Disappearance", + "value": "barley_supply_disappearance" + }, + { + "label": "Barley World Production Consumption Stocks", + "value": "barley_world_production_consumption_stocks" + }, + { + "label": "Barley World Trade", + "value": "barley_world_trade" + }, + { + "label": "Beef Veal Production", + "value": "beef_veal_production" + }, + { + "label": "Beef Veal Trade", + "value": "beef_veal_trade" + }, + { + "label": "Butter Production Consumption", + "value": "butter_production_consumption" + }, + { + "label": "Butter Trade", + "value": "butter_trade" + }, + { + "label": "Cattle Stocks", + "value": "cattle_stocks" + }, + { + "label": "Cattle Trade", + "value": "cattle_trade" + }, + { + "label": "Cheese Production Consumption", + "value": "cheese_production_consumption" + }, + { + "label": "Cheese Trade", + "value": "cheese_trade" + }, + { + "label": "Cherries Selected Countries", + "value": "cherries_selected_countries" + }, + { + "label": "Cherries Supply Distribution", + "value": "cherries_supply_distribution" + }, + { + "label": "Chicken Production", + "value": "chicken_production" + }, + { + "label": "Chicken Trade", + "value": "chicken_trade" + }, + { + "label": "China Grain Supply Demand", + "value": "china_grain_supply_demand" + }, + { + "label": "Coarse Grains Area Yield Production", + "value": "coarse_grains_area_yield_production" + }, + { + "label": "Coarse Grains Regional", + "value": "coarse_grains_regional" + }, + { + "label": "Coarse Grains World Production Consumption Stocks", + "value": "coarse_grains_world_production_consumption_stocks" + }, + { + "label": "Coarse Grains World Trade", + "value": "coarse_grains_world_trade" + }, + { + "label": "Coffee Arabica Production", + "value": "coffee_arabica_production" + }, + { + "label": "Coffee Consumption", + "value": "coffee_consumption" + }, + { + "label": "Coffee Ending Stocks", + "value": "coffee_ending_stocks" + }, + { + "label": "Coffee Exports Green Bean", + "value": "coffee_exports_green_bean" + }, + { + "label": "Coffee Exports Soluble", + "value": "coffee_exports_soluble" + }, + { + "label": "Coffee Exports Total", + "value": "coffee_exports_total" + }, + { + "label": "Coffee Imports Green Bean", + "value": "coffee_imports_green_bean" + }, + { + "label": "Coffee Imports Soluble", + "value": "coffee_imports_soluble" + }, + { + "label": "Coffee Imports Total", + "value": "coffee_imports_total" + }, + { + "label": "Coffee Production", + "value": "coffee_production" + }, + { + "label": "Coffee Robusta Production", + "value": "coffee_robusta_production" + }, + { + "label": "Coffee Summary", + "value": "coffee_summary" + }, + { + "label": "Coffee Summary 2", + "value": "coffee_summary_2" + }, + { + "label": "Coffee Summary 3", + "value": "coffee_summary_3" + }, + { + "label": "Coffee Summary 4", + "value": "coffee_summary_4" + }, + { + "label": "Copra Palm Kernel Palm Oil Production", + "value": "copra_palm_kernel_palm_oil_production" + }, + { + "label": "Corn Area Yield Production", + "value": "corn_area_yield_production" + }, + { + "label": "Corn Barley Supply Demand", + "value": "corn_barley_supply_demand" + }, + { + "label": "Corn Regional", + "value": "corn_regional" + }, + { + "label": "Corn Supply Disappearance", + "value": "corn_supply_disappearance" + }, + { + "label": "Corn World Production Consumption Stocks", + "value": "corn_world_production_consumption_stocks" + }, + { + "label": "Corn World Trade", + "value": "corn_world_trade" + }, + { + "label": "Cotton Area Yield Production", + "value": "cotton_area_yield_production" + }, + { + "label": "Cotton Area Yield Production Fcr", + "value": "cotton_area_yield_production_fcr" + }, + { + "label": "Cotton By Country", + "value": "cotton_by_country" + }, + { + "label": "Cotton By Country 2", + "value": "cotton_by_country_2" + }, + { + "label": "Cotton Foreign Supply", + "value": "cotton_foreign_supply" + }, + { + "label": "Cotton Monthly Changes", + "value": "cotton_monthly_changes" + }, + { + "label": "Cotton Supply Distribution", + "value": "cotton_supply_distribution" + }, + { + "label": "Cotton Supply Distribution 2", + "value": "cotton_supply_distribution_2" + }, + { + "label": "Cotton US Supply", + "value": "cotton_us_supply" + }, + { + "label": "Cotton World Supply", + "value": "cotton_world_supply" + }, + { + "label": "Cotton World Supply USe", + "value": "cotton_world_supply_use" + }, + { + "label": "Cotton World Supply USe 2", + "value": "cotton_world_supply_use_2" + }, + { + "label": "Cottonseed Area Yield Production", + "value": "cottonseed_area_yield_production" + }, + { + "label": "EU Grain Supply Demand", + "value": "eu_grain_supply_demand" + }, + { + "label": "Grains Summary Comparison", + "value": "grains_summary_comparison" + }, + { + "label": "Grapefruit Selected Countries", + "value": "grapefruit_selected_countries" + }, + { + "label": "Grapes Selected Countries", + "value": "grapes_selected_countries" + }, + { + "label": "Grapes Supply Distribution", + "value": "grapes_supply_distribution" + }, + { + "label": "Lemons Limes Selected Countries", + "value": "lemons_limes_selected_countries" + }, + { + "label": "Milk Cow Numbers", + "value": "milk_cow_numbers" + }, + { + "label": "Milk Production Consumption", + "value": "milk_production_consumption" + }, + { + "label": "Nonfat Dry Milk Production Consumption", + "value": "nonfat_dry_milk_production_consumption" + }, + { + "label": "Nonfat Dry Milk Trade", + "value": "nonfat_dry_milk_trade" + }, + { + "label": "Oats Area Yield Production", + "value": "oats_area_yield_production" + }, + { + "label": "Oats Regional", + "value": "oats_regional" + }, + { + "label": "Oats World Production Consumption Stocks", + "value": "oats_world_production_consumption_stocks" + }, + { + "label": "Oats World Trade", + "value": "oats_world_trade" + }, + { + "label": "Oilseeds Area Yield Production", + "value": "oilseeds_area_yield_production" + }, + { + "label": "Oilseeds China", + "value": "oilseeds_china" + }, + { + "label": "Oilseeds EU", + "value": "oilseeds_eu" + }, + { + "label": "Oilseeds India", + "value": "oilseeds_india" + }, + { + "label": "Oilseeds Middle East", + "value": "oilseeds_middle_east" + }, + { + "label": "Oilseeds Products World Supply Demand", + "value": "oilseeds_products_world_supply_demand" + }, + { + "label": "Oilseeds Southeast Asia", + "value": "oilseeds_southeast_asia" + }, + { + "label": "Oilseeds US Supply Distribution", + "value": "oilseeds_us_supply_distribution" + }, + { + "label": "Oilseeds World Commodity View", + "value": "oilseeds_world_commodity_view" + }, + { + "label": "Oilseeds World Country View", + "value": "oilseeds_world_country_view" + }, + { + "label": "Orange Juice Supply Distribution", + "value": "orange_juice_supply_distribution" + }, + { + "label": "Oranges Selected Countries", + "value": "oranges_selected_countries" + }, + { + "label": "Oranges Selected Countries 2", + "value": "oranges_selected_countries_2" + }, + { + "label": "Other EUrope Grain Supply Demand", + "value": "other_europe_grain_supply_demand" + }, + { + "label": "Palm Coconut Fishmeal World Supply Demand", + "value": "palm_coconut_fishmeal_world_supply_demand" + }, + { + "label": "Palm Oil World Supply", + "value": "palm_oil_world_supply" + }, + { + "label": "Peaches Nectarines Selected Countries", + "value": "peaches_nectarines_selected_countries" + }, + { + "label": "Peaches Nectarines Supply Distribution", + "value": "peaches_nectarines_supply_distribution" + }, + { + "label": "Peanut Area Yield Production", + "value": "peanut_area_yield_production" + }, + { + "label": "Pears Selected Countries", + "value": "pears_selected_countries" + }, + { + "label": "Pears Supply Distribution", + "value": "pears_supply_distribution" + }, + { + "label": "Pistachios Summary", + "value": "pistachios_summary" + }, + { + "label": "Pistachios Supply Distribution", + "value": "pistachios_supply_distribution" + }, + { + "label": "Pork Production", + "value": "pork_production" + }, + { + "label": "Pork Trade", + "value": "pork_trade" + }, + { + "label": "Protein Meals World Commodity View", + "value": "protein_meals_world_commodity_view" + }, + { + "label": "Protein Meals World Country View", + "value": "protein_meals_world_country_view" + }, + { + "label": "Raisins Selected Countries", + "value": "raisins_selected_countries" + }, + { + "label": "Raisins Supply Distribution", + "value": "raisins_supply_distribution" + }, + { + "label": "Rapeseed Area Yield Production", + "value": "rapeseed_area_yield_production" + }, + { + "label": "Rapeseed Products World Supply", + "value": "rapeseed_products_world_supply" + }, + { + "label": "Rapeseed Products World Supply Demand", + "value": "rapeseed_products_world_supply_demand" + }, + { + "label": "Rice Area Yield Production", + "value": "rice_area_yield_production" + }, + { + "label": "Rice Regional", + "value": "rice_regional" + }, + { + "label": "Rice Supply Demand", + "value": "rice_supply_demand" + }, + { + "label": "Rice World Production Consumption Stocks", + "value": "rice_world_production_consumption_stocks" + }, + { + "label": "Rice World Trade", + "value": "rice_world_trade" + }, + { + "label": "Russia Barley", + "value": "russia_barley" + }, + { + "label": "Russia Corn", + "value": "russia_corn" + }, + { + "label": "Russia Grain Supply Demand", + "value": "russia_grain_supply_demand" + }, + { + "label": "Russia Wheat", + "value": "russia_wheat" + }, + { + "label": "Rye Area Yield Production", + "value": "rye_area_yield_production" + }, + { + "label": "Rye Regional", + "value": "rye_regional" + }, + { + "label": "Rye World Production Consumption Stocks", + "value": "rye_world_production_consumption_stocks" + }, + { + "label": "Rye World Trade", + "value": "rye_world_trade" + }, + { + "label": "Sorghum Area Yield Production", + "value": "sorghum_area_yield_production" + }, + { + "label": "Sorghum Regional", + "value": "sorghum_regional" + }, + { + "label": "Sorghum Supply Disappearance", + "value": "sorghum_supply_disappearance" + }, + { + "label": "Sorghum World Production Consumption Stocks", + "value": "sorghum_world_production_consumption_stocks" + }, + { + "label": "Sorghum World Trade", + "value": "sorghum_world_trade" + }, + { + "label": "Soybean Meal World Supply", + "value": "soybean_meal_world_supply" + }, + { + "label": "Soybean Oil World Supply", + "value": "soybean_oil_world_supply" + }, + { + "label": "Soybeans Area Yield Production", + "value": "soybeans_area_yield_production" + }, + { + "label": "Soybeans Argentina Supply Distribution", + "value": "soybeans_argentina_supply_distribution" + }, + { + "label": "Soybeans Brazil Supply Distribution", + "value": "soybeans_brazil_supply_distribution" + }, + { + "label": "Soybeans Products World Supply Demand", + "value": "soybeans_products_world_supply_demand" + }, + { + "label": "Soybeans Products World Trade", + "value": "soybeans_products_world_trade" + }, + { + "label": "Soybeans US Supply Distribution", + "value": "soybeans_us_supply_distribution" + }, + { + "label": "Soybeans World Supply", + "value": "soybeans_world_supply" + }, + { + "label": "Sugar Ending Stocks", + "value": "sugar_ending_stocks" + }, + { + "label": "Sugar Imports Exports", + "value": "sugar_imports_exports" + }, + { + "label": "Sugar Production Consumption", + "value": "sugar_production_consumption" + }, + { + "label": "Sunflower Area Yield Production", + "value": "sunflower_area_yield_production" + }, + { + "label": "Sunflower Products World Supply", + "value": "sunflower_products_world_supply" + }, + { + "label": "Sunflower Products World Supply Demand", + "value": "sunflower_products_world_supply_demand" + }, + { + "label": "Swine Stocks", + "value": "swine_stocks" + }, + { + "label": "Swine Trade", + "value": "swine_trade" + }, + { + "label": "Tangerines Mandarins Selected Countries", + "value": "tangerines_mandarins_selected_countries" + }, + { + "label": "US Grains Supply Distribution", + "value": "us_grains_supply_distribution" + }, + { + "label": "Vegetable Oils Minor World Supply", + "value": "vegetable_oils_minor_world_supply" + }, + { + "label": "Vegetable Oils World Commodity View", + "value": "vegetable_oils_world_commodity_view" + }, + { + "label": "Vegetable Oils World Country View", + "value": "vegetable_oils_world_country_view" + }, + { + "label": "Walnuts Summary", + "value": "walnuts_summary" + }, + { + "label": "Walnuts Supply Distribution", + "value": "walnuts_supply_distribution" + }, + { + "label": "Wheat Area Yield Production", + "value": "wheat_area_yield_production" + }, + { + "label": "Wheat Coarse Grains Supply Demand", + "value": "wheat_coarse_grains_supply_demand" + }, + { + "label": "Wheat Coarse Grains World Supply Demand", + "value": "wheat_coarse_grains_world_supply_demand" + }, + { + "label": "Wheat Flour Products World Trade", + "value": "wheat_flour_products_world_trade" + }, + { + "label": "Wheat Regional", + "value": "wheat_regional" + }, + { + "label": "Wheat Supply Disappearance", + "value": "wheat_supply_disappearance" + }, + { + "label": "Wheat World Production Consumption Stocks", + "value": "wheat_world_production_consumption_stocks" + }, + { + "label": "Whole Milk Powder Production Consumption", + "value": "whole_milk_powder_production_consumption" + }, + { + "label": "Whole Milk Powder Trade", + "value": "whole_milk_powder_trade" + }, + { + "label": "World Crop Production Summary", + "value": "world_crop_production_summary" + } + ], + "style": { + "popupWidth": 350 + }, + "row": 1 + } + } + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity name to filter the data. If provided, retrieves time series data for the given commodity. Supplying both 'report_id' and 'commodity' will prioritize 'commodity' for time series data. Valid commodities are:\n almonds, apples, barley, beef, broiler, butter, cattle, cheese, cherries, chicken, coffee, corn, cotton, dry_whole_milk_powder, fluid_milk, grapefruit, grapes, lemons_limes, meal_copra, meal_cottonseed, meal_fish, meal_palm_kernel, meal_peanut, meal_rapeseed, meal_soybean, meal_sunflowerseed, millet, mixed_grain, nonfat_dry_milk, oats, oil_coconut, oil_cottonseed, oil_olive, oil_palm, oil_palm_kernel, oil_peanut, oil_rapeseed, oil_soybean, oil_sunflowerseed, oilseed_copra, oilseed_cottonseed, oilseed_palm_kernel, oilseed_peanut, oilseed_rapeseed, oilseed_soybean, oilseed_sunflowerseed, orange_juice, oranges, peaches_nectarines, pears, pistachios, pork, rice, rye, sorghum, sugar, swine, tangerines_mandarins, walnuts, wheat", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "description": "Commodity name to filter the data. If provided, overrides the Report ID and retrieves time series data for the given commodity.", + "value": null, + "options": [ + { + "label": "Report Mode", + "value": null + }, + { + "label": "Almonds", + "value": "almonds" + }, + { + "label": "Apples", + "value": "apples" + }, + { + "label": "Barley", + "value": "barley" + }, + { + "label": "Beef", + "value": "beef" + }, + { + "label": "Broiler", + "value": "broiler" + }, + { + "label": "Butter", + "value": "butter" + }, + { + "label": "Cattle", + "value": "cattle" + }, + { + "label": "Cheese", + "value": "cheese" + }, + { + "label": "Cherries", + "value": "cherries" + }, + { + "label": "Chicken", + "value": "chicken" + }, + { + "label": "Coffee", + "value": "coffee" + }, + { + "label": "Corn", + "value": "corn" + }, + { + "label": "Cotton", + "value": "cotton" + }, + { + "label": "Dry Whole Milk Powder", + "value": "dry_whole_milk_powder" + }, + { + "label": "Fluid Milk", + "value": "fluid_milk" + }, + { + "label": "Grapefruit", + "value": "grapefruit" + }, + { + "label": "Grapes", + "value": "grapes" + }, + { + "label": "Lemons Limes", + "value": "lemons_limes" + }, + { + "label": "Meal Copra", + "value": "meal_copra" + }, + { + "label": "Meal Cottonseed", + "value": "meal_cottonseed" + }, + { + "label": "Meal Fish", + "value": "meal_fish" + }, + { + "label": "Meal Palm Kernel", + "value": "meal_palm_kernel" + }, + { + "label": "Meal Peanut", + "value": "meal_peanut" + }, + { + "label": "Meal Rapeseed", + "value": "meal_rapeseed" + }, + { + "label": "Meal Soybean", + "value": "meal_soybean" + }, + { + "label": "Meal Sunflowerseed", + "value": "meal_sunflowerseed" + }, + { + "label": "Millet", + "value": "millet" + }, + { + "label": "Mixed Grain", + "value": "mixed_grain" + }, + { + "label": "Nonfat Dry Milk", + "value": "nonfat_dry_milk" + }, + { + "label": "Oats", + "value": "oats" + }, + { + "label": "Oil Coconut", + "value": "oil_coconut" + }, + { + "label": "Oil Cottonseed", + "value": "oil_cottonseed" + }, + { + "label": "Oil Olive", + "value": "oil_olive" + }, + { + "label": "Oil Palm", + "value": "oil_palm" + }, + { + "label": "Oil Palm Kernel", + "value": "oil_palm_kernel" + }, + { + "label": "Oil Peanut", + "value": "oil_peanut" + }, + { + "label": "Oil Rapeseed", + "value": "oil_rapeseed" + }, + { + "label": "Oil Soybean", + "value": "oil_soybean" + }, + { + "label": "Oil Sunflowerseed", + "value": "oil_sunflowerseed" + }, + { + "label": "Oilseed Copra", + "value": "oilseed_copra" + }, + { + "label": "Oilseed Cottonseed", + "value": "oilseed_cottonseed" + }, + { + "label": "Oilseed Palm Kernel", + "value": "oilseed_palm_kernel" + }, + { + "label": "Oilseed Peanut", + "value": "oilseed_peanut" + }, + { + "label": "Oilseed Rapeseed", + "value": "oilseed_rapeseed" + }, + { + "label": "Oilseed Soybean", + "value": "oilseed_soybean" + }, + { + "label": "Oilseed Sunflowerseed", + "value": "oilseed_sunflowerseed" + }, + { + "label": "Orange Juice", + "value": "orange_juice" + }, + { + "label": "Oranges", + "value": "oranges" + }, + { + "label": "Peaches Nectarines", + "value": "peaches_nectarines" + }, + { + "label": "Pears", + "value": "pears" + }, + { + "label": "Pistachios", + "value": "pistachios" + }, + { + "label": "Pork", + "value": "pork" + }, + { + "label": "Rice", + "value": "rice" + }, + { + "label": "Rye", + "value": "rye" + }, + { + "label": "Sorghum", + "value": "sorghum" + }, + { + "label": "Sugar", + "value": "sugar" + }, + { + "label": "Swine", + "value": "swine" + }, + { + "label": "Tangerines Mandarins", + "value": "tangerines_mandarins" + }, + { + "label": "Walnuts", + "value": "walnuts" + }, + { + "label": "Wheat", + "value": "wheat" + } + ], + "row": 1 + } + } + }, + { + "name": "attribute", + "type": "list[str] | str | None | list[list[str] | str | None]", + "description": "Attribute to filter the data. If None, retrieves all available attributes for the commodity.\nParameter is ignored when commodity is None. Valid attributes depend on the commodity, an invalid choice will show the available attributes for the entered commodity.\nAll attributes choices are:\nannual_pct_change_per_cap_cons, arabica_production, area_harvested, area_planted, balance, bean_exports, bean_imports, bearing_trees, beef_cows_beg_stocks, beet_sugar_production, begin_stock_ctrl_app, begin_stock_other, beginning_stocks, calf_slaughter, cane_sugar_production, catch_for_reduction, commercial_production, consumption_change, cow_change, cow_slaughter, cows_in_milk, cows_milk_production, crush, cy_exp_to_us, cy_exports, cy_imp_from_us, cy_imports, dairy_cows_beg_stocks, deliv_to_processors, dom_consump_ctrl_app, dom_consump_other, dom_leaf_consumption, domestic_consumption, domestic_use, end_stocks_ctrl_app, end_stocks_other, ending_stocks, export_change, exportable_production, exports, exports_percent_production, extr_rate, factory_use_consum, farm_sales_weight_prod, feed_dom_consumption, feed_use_dom_consum, feed_waste_dom_cons, filter_production, fluid_use_dom_consum, food_use_dom_cons, for_processing, fresh_dom_consumption, fresh_dom_consumption_alt, fsi_consumption, human_consumption, human_dom_consumption, import_change, imports, imports_percent_consumption, industrial_dom_cons, intra_eu_exports, intra_eu_exports_alt, intra_eu_imports, inventory_balance, inventory_change, inventory_reference, loss, loss_and_residual, milling_rate, my_exp_to_eu, my_imp_from_eu, my_imp_from_us, non_bearing_trees, non_comm_production, non_filter_production, other_disappearance, other_exports, other_foreign_cons, other_imports, other_milk_production, other_production, other_slaughter, other_use_losses, per_capita_consumption, population, prod_from_table_grapes, prod_from_wine_grapes, production, production_change, production_to_cows, production_to_sows, raw_exports, raw_imports, refined_exp_raw_val, refined_imp_raw_val, roast_ground_exports, roast_ground_imports, robusta_production, rough_production, rst_ground_dom_consum, seed_to_lint_ratio, slaughter_reference, slaughter_to_inventory, slaughter_to_total_supply, sme, soluble_dom_cons, soluble_exports, soluble_imports, sow_beginning_stocks, sow_change, sow_slaughter, stocks_to_use, stocks_to_use_months, total_disappearance, total_disappearance_alt, total_distribution, total_grape_crush, total_slaughter, total_supply, total_trees, total_use, total_utilization, ty_exports, ty_imp_from_us, ty_imports, us_leaf_dom_cons, us_leaf_imports, utilization_for_alcohol, utilization_for_sugar, weights, withdrawal_from_market, yield Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "multiSelect": false, + "multiple": false, + "description": "Attribute to filter the data. Ignored when commodity is Report Mode. If None, retrieves all available attributes for the commodity. The choices are scoped to the selected commodity.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/psd_data_attributes", + "optionsParams": { + "commodity": "$commodity" + }, + "style": { + "popupWidth": 320 + }, + "row": 1 + } + } + }, + { + "name": "country", + "type": "list[str] | str | None | list[list[str] | str | None]", + "description": "Country code(s) to filter the data. If None, retrieves data for all countries.\nParameter is ignored when commodity is None. Valid country codes include:\nafghanistan, albania, algeria, angola, argentina, armenia, australia, austria, azerbaijan, bahamas, bahrain, bangladesh, barbados, belarus, belgium, belize, benin, bhutan, bolivia, bosnia_and_herzegovina, botswana, brazil, brunei, bulgaria, burkina_faso, burma, burundi, cabo_verde, cambodia, cameroon, canada, caribbean, central_african_republic, central_america, chad, chile, china, colombia, comoros, congo_brazzaville, congo_kinshasa, costa_rica, cote_divoire, croatia, cuba, cyprus, czech_republic, czechia, denmark, djibouti, dominica, dominican_republic, east_asia, ecuador, egypt, el_salvador, equatorial_guinea, eritrea, estonia, eswatini, ethiopia, eu, eu_15, eu_25, european_union, fiji, finland, former_soviet_union, france, gabon, gambia, georgia, germany, ghana, greece, guatemala, guinea, guinea_bissau, guyana, haiti, honduras, hong_kong, hungary, iceland, india, indonesia, iran, iraq, ireland, israel, italy, ivory_coast, jamaica, japan, jordan, kazakhstan, kenya, kosovo, kuwait, kyrgyzstan, laos, latvia, lebanon, lesotho, liberia, libya, lithuania, luxembourg, macau, macedonia, madagascar, malawi, malaysia, maldives, mali, malta, mauritania, mauritius, mexico, middle_east, moldova, mongolia, montenegro, morocco, mozambique, myanmar, namibia, nepal, netherlands, new_caledonia, new_zealand, nicaragua, niger, nigeria, north_africa, north_america, north_korea, north_macedonia, norway, oceania, oman, other_europe, pakistan, panama, papua_new_guinea, paraguay, peru, philippines, poland, portugal, puerto_rico, qatar, reunion, romania, russia, rwanda, samoa, sao_tome_and_principe, saudi_arabia, senegal, serbia, seychelles, sierra_leone, singapore, slovakia, slovenia, solomon_islands, somalia, south_africa, south_america, south_asia, south_korea, south_sudan, southeast_asia, spain, sri_lanka, sub_saharan_africa, sudan, suriname, swaziland, sweden, switzerland, syria, taiwan, tajikistan, tanzania, thailand, togo, tonga, trinidad_and_tobago, tunisia, turkey, turkmenistan, uganda, ukraine, united_arab_emirates, united_kingdom, united_states, uruguay, uzbekistan, vanuatu, venezuela, vietnam, world, yemen, zambia, zimbabwe Multiple items allowed.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": { + "x-widget_config": { + "multiSelect": false, + "multiple": false, + "description": "Country code(s) to filter the data. Ignored when commodity is Report Mode. If None, retrieves data for all countries. The choices are scoped to the selected commodity.", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/psd_data_countries", + "optionsParams": { + "commodity": "$commodity" + }, + "style": { + "popupWidth": 320 + }, + "row": 1 + } + } + }, + { + "name": "aggregate_regions", + "type": "bool | None", + "description": "Whether to include regional and world aggregates in the data. Parameter is ignored when 'commodity' is None.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "description": "Whether to include regional and world aggregates in the data. Ignored when 'commodity' is Report Mode.", + "type": "boolean", + "value": false, + "row": 1 + } + } + }, + { + "name": "start_year", + "type": "int | None", + "description": "Start year for filtering time series data. None returns from the beginning of the series.\nParameter is ignored when 'commodity' is None.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "description": "Start year for filtering time series data. Ignored when commodity is Report Mode. None returns from the beginning of the series.", + "type": "number", + "options": [ + { + "label": "Start Year", + "value": null + }, + { + "label": "2026", + "value": 2026 + }, + { + "label": "2025", + "value": 2025 + }, + { + "label": "2024", + "value": 2024 + }, + { + "label": "2023", + "value": 2023 + }, + { + "label": "2022", + "value": 2022 + }, + { + "label": "2021", + "value": 2021 + }, + { + "label": "2020", + "value": 2020 + }, + { + "label": "2019", + "value": 2019 + }, + { + "label": "2018", + "value": 2018 + }, + { + "label": "2017", + "value": 2017 + }, + { + "label": "2016", + "value": 2016 + }, + { + "label": "2015", + "value": 2015 + }, + { + "label": "2014", + "value": 2014 + }, + { + "label": "2013", + "value": 2013 + }, + { + "label": "2012", + "value": 2012 + }, + { + "label": "2011", + "value": 2011 + }, + { + "label": "2010", + "value": 2010 + }, + { + "label": "2009", + "value": 2009 + }, + { + "label": "2008", + "value": 2008 + }, + { + "label": "2007", + "value": 2007 + }, + { + "label": "2006", + "value": 2006 + }, + { + "label": "2005", + "value": 2005 + }, + { + "label": "2004", + "value": 2004 + }, + { + "label": "2003", + "value": 2003 + }, + { + "label": "2002", + "value": 2002 + }, + { + "label": "2001", + "value": 2001 + }, + { + "label": "2000", + "value": 2000 + }, + { + "label": "1999", + "value": 1999 + }, + { + "label": "1998", + "value": 1998 + }, + { + "label": "1997", + "value": 1997 + }, + { + "label": "1996", + "value": 1996 + }, + { + "label": "1995", + "value": 1995 + }, + { + "label": "1994", + "value": 1994 + }, + { + "label": "1993", + "value": 1993 + }, + { + "label": "1992", + "value": 1992 + }, + { + "label": "1991", + "value": 1991 + }, + { + "label": "1990", + "value": 1990 + }, + { + "label": "1989", + "value": 1989 + }, + { + "label": "1988", + "value": 1988 + }, + { + "label": "1987", + "value": 1987 + }, + { + "label": "1986", + "value": 1986 + }, + { + "label": "1985", + "value": 1985 + }, + { + "label": "1984", + "value": 1984 + }, + { + "label": "1983", + "value": 1983 + }, + { + "label": "1982", + "value": 1982 + }, + { + "label": "1981", + "value": 1981 + }, + { + "label": "1980", + "value": 1980 + }, + { + "label": "1979", + "value": 1979 + }, + { + "label": "1978", + "value": 1978 + }, + { + "label": "1977", + "value": 1977 + }, + { + "label": "1976", + "value": 1976 + }, + { + "label": "1975", + "value": 1975 + }, + { + "label": "1974", + "value": 1974 + }, + { + "label": "1973", + "value": 1973 + }, + { + "label": "1972", + "value": 1972 + }, + { + "label": "1971", + "value": 1971 + }, + { + "label": "1970", + "value": 1970 + }, + { + "label": "1969", + "value": 1969 + }, + { + "label": "1968", + "value": 1968 + }, + { + "label": "1967", + "value": 1967 + }, + { + "label": "1966", + "value": 1966 + }, + { + "label": "1965", + "value": 1965 + }, + { + "label": "1964", + "value": 1964 + }, + { + "label": "1963", + "value": 1963 + }, + { + "label": "1962", + "value": 1962 + }, + { + "label": "1961", + "value": 1961 + }, + { + "label": "1960", + "value": 1960 + } + ], + "row": 1 + } + } + }, + { + "name": "end_year", + "type": "int | None", + "description": "End year for filtering time series data. If None, returns up to the most recent year.\nParameter is ignored when 'commodity' is None.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "description": "End year for filtering time series data. Ignored when commodity is Report Mode. If None, returns up to the most recent year.", + "type": "number", + "options": [ + { + "label": "End Year", + "value": null + }, + { + "label": "2026", + "value": 2026 + }, + { + "label": "2025", + "value": 2025 + }, + { + "label": "2024", + "value": 2024 + }, + { + "label": "2023", + "value": 2023 + }, + { + "label": "2022", + "value": 2022 + }, + { + "label": "2021", + "value": 2021 + }, + { + "label": "2020", + "value": 2020 + }, + { + "label": "2019", + "value": 2019 + }, + { + "label": "2018", + "value": 2018 + }, + { + "label": "2017", + "value": 2017 + }, + { + "label": "2016", + "value": 2016 + }, + { + "label": "2015", + "value": 2015 + }, + { + "label": "2014", + "value": 2014 + }, + { + "label": "2013", + "value": 2013 + }, + { + "label": "2012", + "value": 2012 + }, + { + "label": "2011", + "value": 2011 + }, + { + "label": "2010", + "value": 2010 + }, + { + "label": "2009", + "value": 2009 + }, + { + "label": "2008", + "value": 2008 + }, + { + "label": "2007", + "value": 2007 + }, + { + "label": "2006", + "value": 2006 + }, + { + "label": "2005", + "value": 2005 + }, + { + "label": "2004", + "value": 2004 + }, + { + "label": "2003", + "value": 2003 + }, + { + "label": "2002", + "value": 2002 + }, + { + "label": "2001", + "value": 2001 + }, + { + "label": "2000", + "value": 2000 + }, + { + "label": "1999", + "value": 1999 + }, + { + "label": "1998", + "value": 1998 + }, + { + "label": "1997", + "value": 1997 + }, + { + "label": "1996", + "value": 1996 + }, + { + "label": "1995", + "value": 1995 + }, + { + "label": "1994", + "value": 1994 + }, + { + "label": "1993", + "value": 1993 + }, + { + "label": "1992", + "value": 1992 + }, + { + "label": "1991", + "value": 1991 + }, + { + "label": "1990", + "value": 1990 + }, + { + "label": "1989", + "value": 1989 + }, + { + "label": "1988", + "value": 1988 + }, + { + "label": "1987", + "value": 1987 + }, + { + "label": "1986", + "value": 1986 + }, + { + "label": "1985", + "value": 1985 + }, + { + "label": "1984", + "value": 1984 + }, + { + "label": "1983", + "value": 1983 + }, + { + "label": "1982", + "value": 1982 + }, + { + "label": "1981", + "value": 1981 + }, + { + "label": "1980", + "value": 1980 + }, + { + "label": "1979", + "value": 1979 + }, + { + "label": "1978", + "value": 1978 + }, + { + "label": "1977", + "value": 1977 + }, + { + "label": "1976", + "value": 1976 + }, + { + "label": "1975", + "value": 1975 + }, + { + "label": "1974", + "value": 1974 + }, + { + "label": "1973", + "value": 1973 + }, + { + "label": "1972", + "value": 1972 + }, + { + "label": "1971", + "value": 1971 + }, + { + "label": "1970", + "value": 1970 + }, + { + "label": "1969", + "value": 1969 + }, + { + "label": "1968", + "value": 1968 + }, + { + "label": "1967", + "value": 1967 + }, + { + "label": "1966", + "value": 1966 + }, + { + "label": "1965", + "value": 1965 + }, + { + "label": "1964", + "value": 1964 + }, + { + "label": "1963", + "value": 1963 + }, + { + "label": "1962", + "value": 1962 + }, + { + "label": "1961", + "value": 1961 + }, + { + "label": "1960", + "value": 1960 + } + ], + "row": 1 + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "CommodityPsdData", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "region", + "type": "str | None", + "description": "Region group category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country or area name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "commodity", + "type": "str | None", + "description": "Commodity name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "attribute", + "type": "str | None", + "description": "Name of the row value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "marketing_year", + "type": "str | None", + "description": "Marketing year for the commodity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "Value for the commodity attribute in the given marketing year.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of measurement for the value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "usda": [ + { + "name": "marketing_year", + "type": "str | None", + "description": "Marketing year for the commodity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | int | None", + "description": "Value for the commodity attribute in the given marketing year.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CommodityPsdData", + "openapi_extra": { + "model": "CommodityPsdData" + } + }, + "/usda/psd_report": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download one, or more, USDA FAS commodity PSD circulars.\n\nThis command returns only the results portion of the OBBject response.\nIt contains a list of dictionaries where the base64 encoded content of the\ndocument is under the 'content' key.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.psd_report(provider='usda', urls=['https://apps.fas.usda.gov/PSDOnline/Circulars/2026/01/Citrus.pdf'])\n# List the latest circular for every commodity, then download them.\nurls = [d['value'] for d in obb.usda.psd_report_urls()]\npdfs = obb.usda.psd_report(urls=urls)\n```\n\n", + "parameters": { + "standard": [], + "usda": [ + { + "name": "urls", + "type": "dict[str, list[str]] | list[str] | str | list[dict[str, list[str]] | list[str] | str]", + "description": "Circular URLs to download, as returned by the psd_report_urls endpoint. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [], + "usda": [ + { + "name": "error_type", + "type": "str | None", + "description": "Error type, if the circular could not be downloaded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "content", + "type": "str", + "description": "Base64-encoded PDF document.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "filename", + "type": "str | None", + "description": "The filename of the downloaded PDF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "data_format", + "type": "dict[str, str] | None", + "description": "Data format information, including data type and filename.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "CommodityPsdReport", + "openapi_extra": { + "widget_config": { + "name": "USDA FAS Commodity Production Supply & Distribution Reports", + "description": "World Markets and Trade circulars released by the USDA Foreign Agricultural Service. Selecting a commodity offers every historical circular for it; with none selected, the latest circular for every commodity is offered.", + "type": "multi_file_viewer", + "refetchInterval": false, + "gridData": { + "w": 20, + "h": 30 + }, + "category": "Commodity", + "subCategory": "Agriculture", + "source": [ + "USDA", + "FAS" + ], + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/psd_report_urls", + "optionsParams": { + "commodity": "$commodity" + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "commodity", + "label": "Commodity", + "description": "Leave empty for the latest circular from every commodity.", + "value": null, + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/psd_report_commodities", + "multiSelect": false + } + ] + }, + "model": "CommodityPsdReport" + } + }, + "/usda/weather_bulletins": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get current and historical weather bulletins with their PDF links.\n\nThis command returns only the results portion of the OBBject response.\nIt contains a list of dictionaries where each dictionary has 'label' and 'value' keys.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get weather bulletins for the current year.\nobb.usda.weather_bulletins(provider='usda')\n# Get weather bulletins for May 2023, week 2.\nobb.usda.weather_bulletins(provider='usda', year=2023, month=5, week=2)\n# Get URLs for comparing versus 1 year ago and download the base64-encoded PDF content to memory.\nfrom datetime import datetime\nurls = []\nfor year in [datetime.now().year, datetime.now().year - 1]:\n urls.append(obb.usda.weather_bulletins(year=year, month=5, week=2)[0]['value'])\npdfs = obb.usda.weather_bulletins_download(urls=urls)\n```\n\n", + "parameters": { + "standard": [ + { + "name": "year", + "type": "int | None", + "description": "Year of the data. Default is the current year.", + "default": 2026, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "month", + "type": "int | None", + "description": "Month of the data. If not provided, data for the entire year is returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "week", + "type": "int | None", + "description": "Numeric week of the data, relative to the month. If not provided, data for the entire month is returned.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "usda": [] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [ + { + "name": "label", + "type": "str | None", + "description": "Label representing the weather bulletin file.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "str | None", + "description": "URL to the weather bulletin document.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "usda": [] + }, + "model": "WeatherBulletin", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "WeatherBulletin" + } + }, + "/usda/weather_bulletins_download": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Download one, or more, weather bulletin documents.\n\nThis command returns only the results portion of the OBBject response.\nIt contains a list of dictionaries where the base64 encoded content of the document is under the 'content' key.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.usda.weather_bulletins_download(provider='usda', urls=['https://esmis.nal.usda.gov/sites/default/release-files/cj82k728n/9w033w568/x059f4232/wwcb0125.pdf'])\n```\n\n", + "parameters": { + "standard": [ + { + "name": "urls", + "type": "dict | list | str | list[dict | list | str]", + "description": "URLs for reports to download. Multiple items allowed for provider(s): usda.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "usda": { + "multiple_items_allowed": true + } + } + } + ], + "usda": [] + }, + "returns": { + "Any": { + "description": "Unvalidated results object." + } + }, + "data": { + "standard": [ + { + "name": "content", + "type": "str", + "description": "Base64 encoded content of the weather bulletin document.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "usda": [ + { + "name": "data_format", + "type": "dict[str, str]", + "description": "Data format information.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "WeatherBulletinDownload", + "openapi_extra": { + "widget_config": { + "name": "USDA Weather & Crop Bulletin", + "description": "Weekly Weather and Crop Bulletin from the USDA.", + "type": "multi_file_viewer", + "refetchInterval": false, + "gridData": { + "w": 20, + "h": 30 + }, + "category": "Commodity", + "subCategory": "Agriculture", + "source": [ + "USDA", + "WAOB" + ], + "params": [ + { + "paramName": "urls", + "type": "endpoint", + "optionsEndpoint": "/api/v1/usda/weather_bulletins", + "optionsParams": { + "year": "$year", + "month": "$month", + "week": "$week", + "provider": "usda" + }, + "show": false, + "multiSelect": true, + "roles": [ + "fileSelector" + ] + }, + { + "paramName": "year", + "type": "number", + "label": "Year", + "value": 2026, + "options": [ + { + "value": 2026, + "label": "2026" + }, + { + "value": 2025, + "label": "2025" + }, + { + "value": 2024, + "label": "2024" + }, + { + "value": 2023, + "label": "2023" + }, + { + "value": 2022, + "label": "2022" + }, + { + "value": 2021, + "label": "2021" + }, + { + "value": 2020, + "label": "2020" + }, + { + "value": 2019, + "label": "2019" + }, + { + "value": 2018, + "label": "2018" + }, + { + "value": 2017, + "label": "2017" + }, + { + "value": 2016, + "label": "2016" + }, + { + "value": 2015, + "label": "2015" + }, + { + "value": 2014, + "label": "2014" + }, + { + "value": 2013, + "label": "2013" + }, + { + "value": 2012, + "label": "2012" + }, + { + "value": 2011, + "label": "2011" + }, + { + "value": 2010, + "label": "2010" + }, + { + "value": 2009, + "label": "2009" + }, + { + "value": 2008, + "label": "2008" + }, + { + "value": 2007, + "label": "2007" + }, + { + "value": 2006, + "label": "2006" + }, + { + "value": 2005, + "label": "2005" + }, + { + "value": 2004, + "label": "2004" + }, + { + "value": 2003, + "label": "2003" + }, + { + "value": 2002, + "label": "2002" + }, + { + "value": 2001, + "label": "2001" + }, + { + "value": 2000, + "label": "2000" + }, + { + "value": 1999, + "label": "1999" + }, + { + "value": 1998, + "label": "1998" + }, + { + "value": 1997, + "label": "1997" + }, + { + "value": 1996, + "label": "1996" + }, + { + "value": 1995, + "label": "1995" + }, + { + "value": 1994, + "label": "1994" + }, + { + "value": 1993, + "label": "1993" + }, + { + "value": 1992, + "label": "1992" + }, + { + "value": 1991, + "label": "1991" + }, + { + "value": 1990, + "label": "1990" + }, + { + "value": 1989, + "label": "1989" + }, + { + "value": 1988, + "label": "1988" + }, + { + "value": 1987, + "label": "1987" + }, + { + "value": 1986, + "label": "1986" + }, + { + "value": 1985, + "label": "1985" + }, + { + "value": 1984, + "label": "1984" + }, + { + "value": 1983, + "label": "1983" + }, + { + "value": 1982, + "label": "1982" + }, + { + "value": 1981, + "label": "1981" + }, + { + "value": 1980, + "label": "1980" + }, + { + "value": 1979, + "label": "1979" + }, + { + "value": 1978, + "label": "1978" + }, + { + "value": 1977, + "label": "1977" + }, + { + "value": 1976, + "label": "1976" + }, + { + "value": 1975, + "label": "1975" + }, + { + "value": 1974, + "label": "1974" + } + ] + }, + { + "paramName": "month", + "type": "number", + "label": "Month", + "value": null, + "options": [ + { + "value": 1, + "label": "January" + }, + { + "value": 2, + "label": "February" + }, + { + "value": 3, + "label": "March" + }, + { + "value": 4, + "label": "April" + }, + { + "value": 5, + "label": "May" + }, + { + "value": 6, + "label": "June" + }, + { + "value": 7, + "label": "July" + }, + { + "value": 8, + "label": "August" + }, + { + "value": 9, + "label": "September" + }, + { + "value": 10, + "label": "October" + }, + { + "value": 11, + "label": "November" + }, + { + "value": 12, + "label": "December" + }, + { + "value": null, + "label": "All Months" + } + ] + }, + { + "paramName": "week", + "type": "number", + "label": "Week", + "value": null, + "options": [ + { + "value": 1, + "label": "1" + }, + { + "value": 2, + "label": "2" + }, + { + "value": 3, + "label": "3" + }, + { + "value": 4, + "label": "4" + }, + { + "value": 5, + "label": "5" + }, + { + "value": null, + "label": "All Weeks" + } + ] + }, + { + "paramName": "provider", + "show": false, + "value": "usda", + "type": "text", + "options": [ + { + "value": "usda", + "label": "usda" + } + ] + } + ] + }, + "model": "WeatherBulletinDownload" + } + }, + "/ustreasury/debt_to_penny": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the total public debt outstanding, to the penny, for each business day.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.debt_to_penny(provider='us_treasury')\n# Get the debt for a specific date range.\nobb.ustreasury.debt_to_penny(start_date='2025-01-01', end_date='2025-06-30', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Data begins 1993-04-01. When None, defaults to the trailing 365 days rather than the full history; set it explicitly to reach further back.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DebtToPenny", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "total_public_debt_outstanding", + "type": "float", + "description": "Total public debt outstanding, in dollars, to the penny.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "debt_held_public", + "type": "float | None", + "description": "Debt held by the public, in dollars. Excludes Federal Financing Bank securities.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Debt Held by the Public" + } + } + }, + { + "name": "intragovernmental_holdings", + "type": "float | None", + "description": "Intragovernmental holdings, in dollars. Includes Federal Financing Bank securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "DebtToPenny", + "openapi_extra": { + "model": "DebtToPenny" + } + }, + "/ustreasury/daily_statement": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get a table of the Daily Treasury Statement - cash and debt operations of the U.S. Treasury.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.daily_statement(provider='us_treasury')\n# Get the deposits and withdrawals of operating cash for June 2025.\nobb.ustreasury.daily_statement(table='deposits_withdrawals_operating_cash', start_date='2025-06-01', end_date='2025-06-30', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "table", + "type": "str | None", + "description": "The DTS table to query. federal_tax_deposits and short_term_cash_investments are discontinued, frozen at 2023-02-13; inter_agency_tax_transfers begins 2023-02-14.", + "default": "operating_cash_balance", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "multiSelect": false, + "multiple": false, + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "sub_table", + "type": "str | None", + "description": "The sub-table of the selected table to spread into columns, as published, e.g. 'Deposits' or 'Issues'. Use 'all' to combine every sub-table. When None, deposits_withdrawals_operating_cash defaults to 'Deposits' and public_debt_transactions to 'Issues', because those tables are too wide to read whole; every other table defaults to 'all'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Sub-Table", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/dts_sub_tables", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 420 + } + } + } + }, + { + "name": "amount_basis", + "type": "str | None", + "description": "Which reported amount to spread across the line-item columns, as published, e.g. 'Today', 'Month to Date', or 'Fiscal Year to Date'. Selecting one basis keeps a column per line item. When None, the two tables that publish enough line items to be unreadable across every basis default to 'Today' and the rest serve every basis they publish. Use 'all' to force every basis.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Amount Basis", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/dts_amount_bases", + "optionsParams": { + "table": "$table" + }, + "style": { + "popupWidth": 320 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Data begins 2005-10-03. When None, defaults to the trailing 30 days rather than the full history; set it explicitly to reach further back.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "DailyTreasuryStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "DailyTreasuryStatement", + "openapi_extra": { + "model": "DailyTreasuryStatement" + } + }, + "/ustreasury/upcoming_auctions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get marketable Treasury securities scheduled to be announced or auctioned in the coming week.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.upcoming_auctions(provider='us_treasury')\n# Get only the upcoming bill auctions.\nobb.ustreasury.upcoming_auctions(security_type='bill', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "security_type", + "type": "str | None", + "description": "Filter by the type of security.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UpcomingTreasuryAuctions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "auction_date", + "type": "date", + "description": "Date of the auction. Rows read soonest first.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "security_type", + "type": "str", + "description": "Type of security - Bill, Note, Bond, CMB, FRN Note, or TIPS Note.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "security_term", + "type": "str", + "description": "Term of the security. Reopenings carry the remaining term rather than the original term.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "offering_amount", + "type": "float | None", + "description": "Offering amount, in dollars. None when the amount has not yet been announced.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reopening", + "type": "bool", + "description": "Whether the auction is a reopening of an existing security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "announcement_date", + "type": "date", + "description": "Date the terms and conditions notification is made public.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date", + "description": "Date the security is delivered to the investor in exchange for payment.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "as_of_date", + "type": "date", + "description": "Date the published snapshot is current as of.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "UpcomingTreasuryAuctions", + "openapi_extra": { + "model": "UpcomingTreasuryAuctions" + } + }, + "/ustreasury/auction_results": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get announcements and results of marketable Treasury securities auctions back to 1979.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.auction_results(start_date='2025-01-01', end_date='2025-03-31', provider='us_treasury')\n# Get all bond auctions since 2020.\nobb.ustreasury.auction_results(security_type='bond', start_date='2020-01-01', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Filters on the auction date. Data begins 1979-11-15. When None, defaults to the trailing 365 days rather than the full history; set it explicitly to reach further back.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Filters on the auction date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "Filter by security type. TIPS, FRNs, and cash management bills are flagged in the output, not separate types.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "Filter by CUSIP. Accepts a comma-separated list.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TreasuryAuctionResults", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "auction_date", + "type": "date", + "description": "Date of the auction. This is the observation axis of the series, and rows read newest first.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "security_type", + "type": "str", + "description": "Type of the security: Bill, Note, or Bond.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "security_term", + "type": "str", + "description": "Term of the security, e.g. 13-Week or 29-Year 9-Month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the security. Repeats across reopenings; (cusip, issue_date) is the unique key.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date", + "description": "Date the security is issued.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date", + "description": "Date the security matures.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "announcement_date", + "type": "date", + "description": "Date the auction was announced.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price_per_100", + "type": "float | None", + "description": "Settlement price per $100 face value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_interest_per_100", + "type": "float | None", + "description": "Accrued interest per $100 face value, on FRN reopenings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_interest_per_1000", + "type": "float | None", + "description": "Accrued interest per $1,000 face value, on coupon reopenings and back-dated issues.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adjusted_accrued_interest_per_1000", + "type": "float | None", + "description": "Inflation-adjusted accrued interest per $1,000 face value, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adjusted_price", + "type": "float | None", + "description": "Inflation-adjusted price per $100 face value, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "allocation_percentage", + "type": "float | None", + "description": "Share of bids at the high rate or yield that was awarded, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "allocation_percentage_decimals", + "type": "int | None", + "description": "Number of decimals in the allocation percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "announced_cusip", + "type": "str | None", + "description": "CUSIP announced for an unscheduled reopening.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "auction_format", + "type": "str | None", + "description": "Auction format: Single-Price, Multi-Price, or Price-Based.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "avg_median_discount_rate", + "type": "float | None", + "description": "Weighted-average or median discount rate of accepted bill bids, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "avg_median_investment_rate", + "type": "float | None", + "description": "Weighted-average or median investment rate of accepted bill bids, as a normalized decimal (percent / 100). Discontinued after 1998-10-29.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "avg_median_price", + "type": "float | None", + "description": "Weighted-average or median accepted price per $100 face value, on multi-price auctions. Discontinued after 2008-04-03.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "avg_median_discount_margin", + "type": "float | None", + "description": "Weighted-average or median discount margin of accepted FRN bids, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "avg_median_yield", + "type": "float | None", + "description": "Weighted-average or median yield of accepted bids on notes and bonds, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "back_dated", + "type": "bool | None", + "description": "Whether the issue is back-dated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "back_dated_date", + "type": "date | None", + "description": "Date to which the issue is back-dated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_to_cover_ratio", + "type": "float | None", + "description": "Ratio of total tendered to total accepted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "callable", + "type": "bool | None", + "description": "Whether the security is callable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_date", + "type": "date | None", + "description": "Earliest call date, on pre-1985 callable bonds.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "called_date", + "type": "date | None", + "description": "Date the security was called, on pre-1985 callable bonds.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "cash_management_bill", + "type": "bool", + "description": "Whether the security is a cash management bill.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "closing_time_competitive", + "type": "str | None", + "description": "Closing time for competitive tenders, Eastern Time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "closing_time_noncompetitive", + "type": "str | None", + "description": "Closing time for noncompetitive tenders, Eastern Time.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "competitive_accepted", + "type": "float | None", + "description": "Competitive bids accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "competitive_bid_decimals", + "type": "int | None", + "description": "Number of decimals allowed in competitive bids.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "competitive_tendered", + "type": "float | None", + "description": "Competitive bids tendered, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "competitive_tenders_accepted", + "type": "bool | None", + "description": "Whether competitive tenders were accepted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "corpus_cusip", + "type": "str | None", + "description": "CUSIP of the stripped principal component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cpi_base_reference_period", + "type": "str | None", + "description": "CPI base reference period, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currently_outstanding", + "type": "float | None", + "description": "Amount currently outstanding before a reopening, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dated_date", + "type": "date | None", + "description": "Date from which interest accrues, on coupon securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_bidder_accepted", + "type": "float | None", + "description": "Direct bidder tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_bidder_tendered", + "type": "float | None", + "description": "Direct bidder tenders submitted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "estimated_amount_of_publicly_held_maturing_securities", + "type": "float | None", + "description": "Estimated amount of publicly held maturing securities of the same type, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fima_included", + "type": "bool | None", + "description": "Whether FIMA noncompetitive tenders were included.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fima_noncompetitive_accepted", + "type": "float | None", + "description": "FIMA noncompetitive tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fima_noncompetitive_tendered", + "type": "float | None", + "description": "FIMA noncompetitive tenders submitted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_interest_period", + "type": "str | None", + "description": "First interest period: Long, Normal, or Short.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_interest_payment_date", + "type": "date | None", + "description": "Date of the first interest payment, on coupon securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "floating_rate", + "type": "bool", + "description": "Whether the security is a floating rate note.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "frn_index_determination_date", + "type": "date | None", + "description": "Date the FRN index rate was determined.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frn_index_determination_rate", + "type": "float | None", + "description": "FRN index rate on the determination date, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_discount_rate", + "type": "float | None", + "description": "Highest accepted discount rate on bills, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_investment_rate", + "type": "float | None", + "description": "Coupon-equivalent yield of the high discount rate, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_price", + "type": "float | None", + "description": "Price at the highest accepted rate or yield, per $100 face value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_discount_margin", + "type": "float | None", + "description": "Highest accepted discount margin on FRNs, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_yield", + "type": "float | None", + "description": "Highest accepted yield on notes and bonds, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "index_ratio_on_issue_date", + "type": "float | None", + "description": "Inflation index ratio on the issue date, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indirect_bidder_accepted", + "type": "float | None", + "description": "Indirect bidder tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indirect_bidder_tendered", + "type": "float | None", + "description": "Indirect bidder tenders submitted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_payment_frequency", + "type": "str | None", + "description": "Interest payment frequency: Annual, Quarterly, Semi-Annual, or None.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "interest_rate", + "type": "float | None", + "description": "Coupon rate of the security, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low_discount_rate", + "type": "float | None", + "description": "Lowest accepted discount rate on bills, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low_investment_rate", + "type": "float | None", + "description": "Lowest accepted investment rate on multi-price bill auctions, as a normalized decimal (percent / 100). Discontinued after 1998-10-29.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "low_price", + "type": "float | None", + "description": "Lowest accepted price per $100 face value, on multi-price auctions. Discontinued after 2008-04-03.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "low_discount_margin", + "type": "float | None", + "description": "Lowest accepted discount margin on FRNs, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low_yield", + "type": "float | None", + "description": "Lowest accepted yield on notes and bonds, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturing_date", + "type": "date | None", + "description": "Date of the maturing securities being refunded, not the maturity of the offered security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maximum_competitive_award", + "type": "float | None", + "description": "Maximum competitive award to a single bidder, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maximum_noncompetitive_award", + "type": "float | None", + "description": "Maximum noncompetitive award to a single bidder, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maximum_single_bid", + "type": "float | None", + "description": "Maximum single bid, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minimum_bid_amount", + "type": "float | None", + "description": "Minimum bid amount, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minimum_strip_amount", + "type": "float | None", + "description": "Minimum amount that can be stripped, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "minimum_to_issue", + "type": "float | None", + "description": "Minimum amount to issue, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "multiples_to_bid", + "type": "float | None", + "description": "Bid multiples, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "multiples_to_issue", + "type": "float | None", + "description": "Issue multiples, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nlp_exclusion_amount", + "type": "float | None", + "description": "Net long position exclusion amount, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nlp_reporting_threshold", + "type": "float | None", + "description": "Net long position reporting threshold, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncompetitive_accepted", + "type": "float | None", + "description": "Noncompetitive tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "noncompetitive_tenders_accepted", + "type": "bool | None", + "description": "Whether noncompetitive tenders were accepted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "offering_amount", + "type": "float | None", + "description": "Announced offering amount, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_cusip", + "type": "str | None", + "description": "Original CUSIP for an unscheduled reopening.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_dated_date", + "type": "date | None", + "description": "Dated date of the original issue, on reopenings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_issue_date", + "type": "date | None", + "description": "Issue date of the original issue, on reopenings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_security_term", + "type": "str | None", + "description": "Term of the security at original issuance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_announcement", + "type": "str | None", + "description": "PDF filename of the announcement, on treasurydirect.gov.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "pdf_competitive_results", + "type": "str | None", + "description": "PDF filename of the competitive results, on treasurydirect.gov.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "pdf_noncompetitive_results", + "type": "str | None", + "description": "PDF filename of the noncompetitive results, on treasurydirect.gov.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "primary_dealer_accepted", + "type": "float | None", + "description": "Primary dealer tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "primary_dealer_tendered", + "type": "float | None", + "description": "Primary dealer tenders submitted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reference_cpi_on_dated_date", + "type": "float | None", + "description": "Reference CPI on the dated date, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reference_cpi_on_issue_date", + "type": "float | None", + "description": "Reference CPI on the issue date, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reopening", + "type": "bool", + "description": "Whether the auction reopens an existing security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "security_term_day_month", + "type": "str | None", + "description": "Security term expressed in days or months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_term_week_year", + "type": "str | None", + "description": "Security term expressed in weeks or years.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "Series of the security, on coupon securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "soma_accepted", + "type": "float | None", + "description": "SOMA tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "soma_holdings", + "type": "float | None", + "description": "SOMA holdings of maturing securities, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "soma_included", + "type": "bool | None", + "description": "Whether SOMA tenders were included in the offering amount.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "soma_tendered", + "type": "float | None", + "description": "SOMA tenders submitted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "spread", + "type": "float | None", + "description": "FRN spread over the index rate, as a normalized decimal (percent / 100).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standard_interest_payment_per_1000", + "type": "float | None", + "description": "Standard interest payment per $1,000 face value, on coupon securities.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strippable", + "type": "bool | None", + "description": "Whether the security can be stripped.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tiin_conversion_factor_per_1000", + "type": "float | None", + "description": "TIIN conversion factor per $1,000 face value, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_accepted", + "type": "float | None", + "description": "Total tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_tendered", + "type": "float | None", + "description": "Total tenders submitted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "treasury_retail_accepted", + "type": "float | None", + "description": "Treasury retail tenders accepted, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "treasury_retail_tenders_accepted", + "type": "bool | None", + "description": "Whether Treasury retail tenders were accepted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unadjusted_accrued_interest_per_1000", + "type": "float | None", + "description": "Unadjusted accrued interest per $1,000 face value, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unadjusted_price", + "type": "float | None", + "description": "Unadjusted price per $100 face value, on TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xml_announcement", + "type": "str | None", + "description": "XML filename of the announcement, on treasurydirect.gov.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "xml_competitive_results", + "type": "str | None", + "description": "XML filename of the competitive results, on treasurydirect.gov.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + }, + { + "name": "inflation_index_security", + "type": "bool", + "description": "Whether the security is a TIPS.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "tint_cusip_1", + "type": "str | None", + "description": "CUSIP of the first stripped interest component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tint_cusip_2", + "type": "str | None", + "description": "CUSIP of the second stripped interest component.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_special_announcement", + "type": "str | None", + "description": "PDF filename of a special announcement, on treasurydirect.gov.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "TreasuryAuctionResults", + "openapi_extra": { + "model": "TreasuryAuctionResults" + } + }, + "/ustreasury/weekly_bill_offerings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get regular weekly Treasury bill auction results from the Treasury Bulletin PDO-1 table.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.weekly_bill_offerings(provider='us_treasury')\n# Get the weekly bill offerings issued during the first quarter of 2025.\nobb.ustreasury.weekly_bill_offerings(start_date='2025-01-01', end_date='2025-03-31', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Filters on the bill issue date. Data covers issues from 2020-10-01 onward. When None, defaults to the trailing 365 days rather than the full history; set it explicitly to reach further back.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Filters on the bill issue date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TreasuryBillOfferings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "issue_date", + "type": "date", + "description": "Date the bills were issued. This is the observation axis of the series.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "maturity_date", + "type": "date", + "description": "Date the bills mature.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "days_to_maturity", + "type": "int", + "description": "Number of days from issue to maturity, identifying the bill tenor.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bids_tendered", + "type": "float", + "description": "Amount of bids tendered, in dollars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bids_accepted_total", + "type": "float", + "description": "Total amount of bids accepted, in dollars. Includes amounts awarded to the Federal Reserve System.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bids_accepted_competitive", + "type": "float", + "description": "Amount of bids accepted on a competitive basis, in dollars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "bids_accepted_noncompetitive", + "type": "float", + "description": "Amount of bids accepted on a non-competitive basis, in dollars.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high_price_per_hundred", + "type": "float", + "description": "High price per hundred on competitive bids accepted.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high_discount_rate", + "type": "float", + "description": "High discount rate on competitive bids accepted, as a normalized decimal (percent / 100).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high_investment_rate", + "type": "float", + "description": "High investment rate (equivalent coupon-issue yield) on competitive bids accepted, as a normalized decimal (percent / 100).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "record_date", + "type": "date", + "description": "Publication date of the quarterly Treasury Bulletin edition reporting the auction, not the auction date.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "TreasuryBillOfferings", + "openapi_extra": { + "model": "TreasuryBillOfferings" + } + }, + "/ustreasury/bulletin": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get tables from the quarterly Treasury Bulletin - offerings, ownership distribution, currency and coin, foreign currency positions, the Exchange Stabilization Fund, and internal revenue receipts.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.bulletin(table='ofs2', provider='us_treasury')\n# Get the distribution of federal securities by class of investors.\nobb.ustreasury.bulletin(table='ofs1', provider='us_treasury')\n# Get offerings of marketable securities other than regular weekly bills.\nobb.ustreasury.bulletin(table='pdo2', start_date='2025-01-01', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "table", + "type": "str | None", + "description": "The Treasury Bulletin table to query. pdo1: auction results of regular weekly Treasury bills; pdo2: auction results of other marketable securities (CMBs, notes, bonds, TIPS, FRNs); ofs1: distribution of federal securities by class of investors and type of issues; ofs2: estimated ownership of U.S. Treasury securities; uscc1: currency and coin outstanding and in circulation; uscc2: currency in circulation by denomination; fcp1: weekly foreign currency positions of major market participants; fcp2: monthly foreign currency positions of major market participants; fcp3: quarterly foreign currency positions of large market participants; esf1: Exchange Stabilization Fund balances; esf2: Exchange Stabilization Fund statement of net cost; ffo5: internal revenue receipts by state; ffo6: Customs and Border Protection collections of duties, taxes, and fees by district and port.", + "default": "ofs2", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Table", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Estimated ownership of U.S. Treasury securities", + "value": "ofs2" + }, + { + "label": "Federal securities by class of investor and type of issue", + "value": "ofs1" + }, + { + "label": "Auction results - regular weekly Treasury bills", + "value": "pdo1" + }, + { + "label": "Auction results - other marketable securities", + "value": "pdo2" + }, + { + "label": "Currency and coin outstanding and in circulation", + "value": "uscc1" + }, + { + "label": "Currency in circulation by denomination", + "value": "uscc2" + }, + { + "label": "Foreign currency positions - weekly, major participants", + "value": "fcp1" + }, + { + "label": "Foreign currency positions - monthly, major participants", + "value": "fcp2" + }, + { + "label": "Foreign currency positions - quarterly, large participants", + "value": "fcp3" + }, + { + "label": "Exchange Stabilization Fund balances", + "value": "esf1" + }, + { + "label": "Exchange Stabilization Fund statement of net cost", + "value": "esf2" + }, + { + "label": "Internal revenue receipts by state", + "value": "ffo5" + }, + { + "label": "Customs and Border Protection collections by district and port", + "value": "ffo6" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Filters on record_date, the bulletin edition date: PDO, USCC, FCP, and ESF editions fall on the 1st of Mar/Jun/Sep/Dec, FFO editions on Dec 1, and OFS tables use quarter-end dates; for ofs2, record_date is only the date the series was last restated. Editions begin 2021. When None, defaults to the trailing 365 days rather than the full history; set it explicitly to reach further back.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Filters on record_date, the bulletin edition date.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TreasuryBulletin", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "table_code", + "type": "str", + "description": "Treasury Bulletin table code of the row, e.g. 'OFS-2'.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_date", + "type": "date | None", + "description": "Date the figures are as of - the observation axis for the OFS, USCC, FCP, and ESF tables. Declared first so it leads the served columns, which this model orders by field declaration because its omit-None serializer carries no column config.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "record_date", + "type": "date", + "description": "Publication date of the bulletin edition reporting the row; for ofs2, the date the series was last restated. This is edition metadata, not the observation axis.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "auction_date", + "type": "date | None", + "description": "Date of the auction. (pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date | None", + "description": "Date the security was issued. (pdo1, pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "Date the bills mature. (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_to_maturity", + "type": "int | None", + "description": "Number of days from issue to maturity, identifying the bill tenor. (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "Fiscal year the collections were received in. (ffo5, ffo6)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "line_number", + "type": "int | None", + "description": "Line number of the row in the published bulletin table; not present for ofs2.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "classification", + "type": "str | None", + "description": "Primary classification of the row - securities classification (ofs1), securities owner (ofs2), holder category (uscc1), or statement line item (esf1, esf2).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sub_classification", + "type": "str | None", + "description": "Class of investors holding the securities. (ofs1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_type", + "type": "str | None", + "description": "Type of issues held - Marketable, Nonmarketable, or Total. (ofs1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_description", + "type": "str | None", + "description": "Description of the security auctioned, including the rate, type, and maturity. (pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_to_final_maturity", + "type": "str | None", + "description": "Period from the issue date to final maturity, e.g. '42d' or '9y 10m'. (pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "denomination", + "type": "str | None", + "description": "Currency denomination, e.g. '$100', or 'Total Currency'. (uscc2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Foreign currency of the reported positions. (fcp1, fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "U.S. state, or aggregate area, of the collections. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "district", + "type": "str | None", + "description": "Customs district of the collection port. (ffo6)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "port", + "type": "str | None", + "description": "Collection port name, or 'Total' for the district roll-up. (ffo6)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "port_code", + "type": "str | None", + "description": "Five-digit CBP port code; not present on district roll-up rows. (ffo6)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bids_tendered", + "type": "float | None", + "description": "Amount of bids tendered at auction, in dollars. (pdo1, pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bids_accepted", + "type": "float | None", + "description": "Total amount of bids accepted at auction, in dollars. (pdo1, pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bids_accepted_competitive", + "type": "float | None", + "description": "Amount of bids accepted on a competitive basis, in dollars. (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bids_accepted_noncompetitive", + "type": "float | None", + "description": "Amount of bids accepted on a non-competitive basis, in dollars. (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_price_per_hundred", + "type": "float | None", + "description": "High price per hundred on competitive bids accepted. (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_discount_rate", + "type": "float | None", + "description": "High discount rate on competitive bids accepted, as a normalized decimal (percent / 100). (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high_investment_rate", + "type": "float | None", + "description": "High investment rate on competitive bids accepted, as a normalized decimal (percent / 100). (pdo1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accepted_yield_discount_margin", + "type": "float | None", + "description": "Accepted yield for notes, bonds, and TIPS, or discount margin for FRNs, as a normalized decimal (percent / 100). (pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "equivalent_price", + "type": "float | None", + "description": "Equivalent price per hundred for notes and bonds. (pdo2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_amount", + "type": "float | None", + "description": "Amount of securities held, in dollars. (ofs1, ofs2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_currency_and_coins", + "type": "float | None", + "description": "Total currency and coins, in dollars. (uscc1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_currency", + "type": "float | None", + "description": "Total currency, in dollars. (uscc1, uscc2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "federal_reserve_notes", + "type": "float | None", + "description": "Federal Reserve notes, in dollars. (uscc1, uscc2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "us_notes", + "type": "float | None", + "description": "U.S. notes, in dollars; can be negative by denomination. (uscc1, uscc2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency_no_longer_issued", + "type": "float | None", + "description": "Currency no longer issued, in dollars. (uscc1, uscc2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_coins", + "type": "float | None", + "description": "Total coins, in dollars. (uscc1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dollar_coins", + "type": "float | None", + "description": "Dollar coins, in dollars. (uscc1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fractional_coins", + "type": "float | None", + "description": "Fractional coins, in dollars. (uscc1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "per_capita", + "type": "float | None", + "description": "Currency in circulation per capita, in dollars; populated only on the 'Total Currency' row, 0 otherwise. (uscc2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "spot_forward_futures_purchased", + "type": "float | None", + "description": "Spot, forward, and futures contracts purchased, in units of the currency. (fcp1, fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "spot_forward_futures_sold", + "type": "float | None", + "description": "Spot, forward, and futures contracts sold, in units of the currency. (fcp1, fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "net_options_position", + "type": "float | None", + "description": "Net options position, in units of the currency. (fcp1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "assets", + "type": "float | None", + "description": "Foreign currency assets, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "liabilities", + "type": "float | None", + "description": "Foreign currency liabilities, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_options_bought", + "type": "float | None", + "description": "Call options bought, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_options_written", + "type": "float | None", + "description": "Call options written, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "put_options_bought", + "type": "float | None", + "description": "Put options bought, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "put_options_written", + "type": "float | None", + "description": "Put options written, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "options_net_delta", + "type": "float | None", + "description": "Net delta-equivalent options position, in units of the currency. (fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_rate", + "type": "float | None", + "description": "Units of the foreign currency per U.S. dollar; not applicable to U.S. Dollars rows. (fcp1, fcp2, fcp3)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "activity", + "type": "float | None", + "description": "Activity since the last report date, in dollars. (esf1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "balance", + "type": "float | None", + "description": "Balance as of the report date, in dollars. (esf1)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_quarter_amount", + "type": "float | None", + "description": "Amount for the current quarter, in dollars. (esf2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year_to_date_amount", + "type": "float | None", + "description": "Fiscal year-to-date amount, in dollars. (esf2)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_collections", + "type": "float | None", + "description": "Total collections, in dollars - gross internal revenue collections (ffo5) or duties, taxes, and fees collected (ffo6).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_income_taxes", + "type": "float | None", + "description": "Business income taxes collected, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_individual_taxes", + "type": "float | None", + "description": "Total individual taxes collected, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "withheld_income_and_fica_taxes", + "type": "float | None", + "description": "Individual income taxes withheld and FICA taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "not_withheld_income_and_seca_taxes", + "type": "float | None", + "description": "Individual income taxes not withheld and SECA taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unemployment_insurance_taxes", + "type": "float | None", + "description": "Unemployment insurance taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "railroad_retirement_taxes", + "type": "float | None", + "description": "Railroad retirement taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "estate_and_trust_income_taxes", + "type": "float | None", + "description": "Estate and trust income taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "estate_taxes", + "type": "float | None", + "description": "Estate taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gift_taxes", + "type": "float | None", + "description": "Gift taxes, in dollars. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "excise_taxes", + "type": "float | None", + "description": "Excise taxes, in dollars; excludes those collected by CBP and TTB. (ffo5)", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TreasuryBulletin", + "openapi_extra": { + "model": "TreasuryBulletin" + } + }, + "/ustreasury/treasury_auctions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Auctions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.treasury_auctions(provider='us_treasury')\nobb.ustreasury.treasury_auctions(security_type='Bill', start_date='2022-01-01', end_date='2023-01-01', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "security_type", + "type": "str | None", + "description": "Used to only return securities of a particular type.", + "default": null, + "optional": true, + "choices": [ + "bill", + "note", + "bond", + "cmb", + "tips", + "frn" + ], + "multiple_items_allowed": false, + "json_schema_extra": { + "us_treasury": { + "choices": [ + "bill", + "note", + "bond", + "cmb", + "tips", + "frn" + ] + } + } + }, + { + "name": "cusip", + "type": "str | None", + "description": "Filter securities by CUSIP.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "page_size", + "type": "int | None", + "description": "Maximum number of results to return; you must also include pagenum when using pagesize.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "page_num", + "type": "int | None", + "description": "The first page number to display results for; used in combination with page size.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. The default is 90 days ago.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. The default is today.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "us_treasury": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TreasuryAuctions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "cusip", + "type": "str", + "description": "CUSIP of the Security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date", + "description": "The issue date of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str", + "description": "The type of security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "security_term", + "type": "str", + "description": "The term of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date", + "description": "The maturity date of the security.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "interest_rate", + "type": "float | None", + "description": "The interest rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "cpi_on_issue_date", + "type": "float | None", + "description": "Reference CPI rate on the issue date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cpi_on_dated_date", + "type": "float | None", + "description": "Reference CPI rate on the dated date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "announcement_date", + "type": "date | None", + "description": "The announcement date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "auction_date", + "type": "date | None", + "description": "The auction date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "auction_date_year", + "type": "int | None", + "description": "The auction date year of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dated_date", + "type": "date | None", + "description": "The dated date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_payment_date", + "type": "date | None", + "description": "The first payment date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "accrued_interest_per_100", + "type": "float | None", + "description": "Accrued interest per $100.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "accrued_interest_per_1000", + "type": "float | None", + "description": "Accrued interest per $1000.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "adjusted_accrued_interest_per_100", + "type": "float | None", + "description": "Adjusted accrued interest per $100.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "adjusted_accrued_interest_per_1000", + "type": "float | None", + "description": "Adjusted accrued interest per $1000.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "adjusted_price", + "type": "float | None", + "description": "Adjusted price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "allocation_percentage", + "type": "float | None", + "description": "Allocation percentage, as normalized percentage points.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "allocation_percentage_decimals", + "type": "float | None", + "description": "The number of decimals in the Allocation percentage.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "announced_cusip", + "type": "str | None", + "description": "The announced CUSIP of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "auction_format", + "type": "str | None", + "description": "The auction format of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "avg_median_discount_rate", + "type": "float | None", + "description": "The average median discount rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "avg_median_investment_rate", + "type": "float | None", + "description": "The average median investment rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "avg_median_price", + "type": "float | None", + "description": "The average median price paid for the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "avg_median_discount_margin", + "type": "float | None", + "description": "The average median discount margin of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "avg_median_yield", + "type": "float | None", + "description": "The average median yield of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "back_dated", + "type": "str | None", + "description": "Whether the security is back dated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "back_dated_date", + "type": "date | None", + "description": "The back dated date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_to_cover_ratio", + "type": "float | None", + "description": "The bid to cover ratio of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_date", + "type": "date | None", + "description": "The call date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "callable", + "type": "str | None", + "description": "Whether the security is callable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "called_date", + "type": "date | None", + "description": "The called date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_management_bill", + "type": "str | None", + "description": "Whether the security is a cash management bill.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "closing_time_competitive", + "type": "str | None", + "description": "The closing time for competitive bids on the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "closing_time_non_competitive", + "type": "str | None", + "description": "The closing time for non-competitive bids on the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "competitive_accepted", + "type": "int | None", + "description": "The accepted value for competitive bids on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "competitive_accepted_decimals", + "type": "int | None", + "description": "The number of decimals in the Competitive Accepted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "competitive_tendered", + "type": "int | None", + "description": "The tendered value for competitive bids on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "competitive_tenders_accepted", + "type": "str | None", + "description": "Whether competitive tenders are accepted on the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "corp_us_cusip", + "type": "str | None", + "description": "The CUSIP of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cpi_base_reference_period", + "type": "str | None", + "description": "The CPI base reference period of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currently_outstanding", + "type": "int | None", + "description": "The currently outstanding value on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "direct_bidder_accepted", + "type": "int | None", + "description": "The accepted value from direct bidders on the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "direct_bidder_tendered", + "type": "int | None", + "description": "The tendered value from direct bidders on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "est_amount_of_publicly_held_maturing_security", + "type": "int | None", + "description": "The estimated amount of publicly held maturing securities on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "fima_included", + "type": "str | None", + "description": "Whether the security is included in the FIMA (Foreign and International Money Authorities).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fima_non_competitive_accepted", + "type": "int | None", + "description": "The non-competitive accepted value on the security from FIMAs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "fima_non_competitive_tendered", + "type": "int | None", + "description": "The non-competitive tendered value on the security from FIMAs.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "first_interest_period", + "type": "str | None", + "description": "The first interest period of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_interest_payment_date", + "type": "date | None", + "description": "The first interest payment date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "floating_rate", + "type": "str | None", + "description": "Whether the security is a floating rate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frn_index_determination_date", + "type": "date | None", + "description": "The FRN index determination date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "frn_index_determination_rate", + "type": "float | None", + "description": "The FRN index determination rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "high_discount_rate", + "type": "float | None", + "description": "The high discount rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "high_investment_rate", + "type": "float | None", + "description": "The high investment rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "high_price", + "type": "float | None", + "description": "The high price of the security at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "high_discount_margin", + "type": "float | None", + "description": "The high discount margin of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "high_yield", + "type": "float | None", + "description": "The high yield of the security at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "index_ratio_on_issue_date", + "type": "float | None", + "description": "The index ratio on the issue date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "indirect_bidder_accepted", + "type": "int | None", + "description": "The accepted value from indirect bidders on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "indirect_bidder_tendered", + "type": "int | None", + "description": "The tendered value from indirect bidders on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "interest_payment_frequency", + "type": "str | None", + "description": "The interest payment frequency of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low_discount_rate", + "type": "float | None", + "description": "The low discount rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "low_investment_rate", + "type": "float | None", + "description": "The low investment rate of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "low_price", + "type": "float | None", + "description": "The low price of the security at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "low_discount_margin", + "type": "float | None", + "description": "The low discount margin of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "low_yield", + "type": "float | None", + "description": "The low yield of the security at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "maturing_date", + "type": "date | None", + "description": "The maturing date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "max_competitive_award", + "type": "int | None", + "description": "The maximum competitive award at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "max_non_competitive_award", + "type": "int | None", + "description": "The maximum non-competitive award at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "max_single_bid", + "type": "int | None", + "description": "The maximum single bid at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "min_bid_amount", + "type": "int | None", + "description": "The minimum bid amount at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "min_strip_amount", + "type": "int | None", + "description": "The minimum strip amount at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "min_to_issue", + "type": "int | None", + "description": "The minimum to issue at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "multiples_to_bid", + "type": "int | None", + "description": "The multiples to bid at auction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "multiples_to_issue", + "type": "int | None", + "description": "The multiples to issue at auction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nlp_exclusion_amount", + "type": "int | None", + "description": "The NLP exclusion amount at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "nlp_reporting_threshold", + "type": "int | None", + "description": "The NLP reporting threshold at auction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_competitive_accepted", + "type": "int | None", + "description": "The accepted value from non-competitive bidders on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "non_competitive_tenders_accepted", + "type": "str | None", + "description": "Whether or not the auction accepted non-competitive tenders.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "offering_amount", + "type": "int | None", + "description": "The offering amount at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "original_cusip", + "type": "str | None", + "description": "The original CUSIP of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_dated_date", + "type": "date | None", + "description": "The original dated date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_issue_date", + "type": "date | None", + "description": "The original issue date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_security_term", + "type": "str | None", + "description": "The original term of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_announcement", + "type": "str | None", + "description": "The PDF filename for the announcement of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_competitive_results", + "type": "str | None", + "description": "The PDF filename for the competitive results of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_non_competitive_results", + "type": "str | None", + "description": "The PDF filename for the non-competitive results of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pdf_special_announcement", + "type": "str | None", + "description": "The PDF filename for the special announcements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_per_100", + "type": "float | None", + "description": "The price per 100 of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "primary_dealer_accepted", + "type": "int | None", + "description": "The primary dealer accepted value on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "primary_dealer_tendered", + "type": "int | None", + "description": "The primary dealer tendered value on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "reopening", + "type": "str | None", + "description": "Whether or not the auction was reopened.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_term_day_month", + "type": "str | None", + "description": "The security term in days or months.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_term_week_year", + "type": "str | None", + "description": "The security term in weeks or years.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "series", + "type": "str | None", + "description": "The series name of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "soma_accepted", + "type": "int | None", + "description": "The SOMA accepted value on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "soma_holdings", + "type": "int | None", + "description": "The SOMA holdings on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "soma_included", + "type": "str | None", + "description": "Whether or not the SOMA (System Open Market Account) was included on the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "soma_tendered", + "type": "int | None", + "description": "The SOMA tendered value on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "spread", + "type": "float | None", + "description": "The spread on the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "standard_payment_per_1000", + "type": "float | None", + "description": "The standard payment per 1000 of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "strippable", + "type": "str | None", + "description": "Whether or not the security is strippable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "term", + "type": "str | None", + "description": "The term of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tiin_conversion_factor_per_1000", + "type": "float | None", + "description": "The TIIN conversion factor per 1000 of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tips", + "type": "str | None", + "description": "Whether or not the security is TIPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_accepted", + "type": "int | None", + "description": "The total accepted value at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "total_tendered", + "type": "int | None", + "description": "The total tendered value at auction.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "treasury_retail_accepted", + "type": "int | None", + "description": "The accepted value on the security from retail.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "treasury_retail_tenders_accepted", + "type": "str | None", + "description": "Whether or not the tender offers from retail are accepted", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "type", + "type": "str | None", + "description": "The type of issuance. This might be different than the security type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unadjusted_accrued_interest_per_1000", + "type": "float | None", + "description": "The unadjusted accrued interest per 1000 of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "unadjusted_price", + "type": "float | None", + "description": "The unadjusted price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "updated_timestamp", + "type": "datetime | None", + "description": "The updated timestamp of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xml_announcement", + "type": "str | None", + "description": "The XML filename for the announcement of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xml_competitive_results", + "type": "str | None", + "description": "The XML filename for the competitive results of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "xml_special_announcement", + "type": "str | None", + "description": "The XML filename for special announcements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tint_cusip1", + "type": "str | None", + "description": "Tint CUSIP 1.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tint_cusip2", + "type": "str | None", + "description": "Tint CUSIP 2.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "us_treasury": [ + { + "name": "tint_cusip1_due_date", + "type": "date | None", + "description": "Tint CUSIP 1 due date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "tint_cusip2_due_date", + "type": "date | None", + "description": "Tint CUSIP 2 due date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "TreasuryAuctions", + "openapi_extra": { + "model": "TreasuryAuctions" + } + }, + "/ustreasury/treasury_prices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Government Treasury Prices by date.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.ustreasury.treasury_prices(provider='us_treasury')\nobb.ustreasury.treasury_prices(date='2019-02-05', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "A specific date to get data for. Defaults to the last business day.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "us_treasury": [ + { + "name": "cusip", + "type": "str | None", + "description": "Filter by CUSIP.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "Filter by security type.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "TreasuryPrices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "issuer_name", + "type": "str | None", + "description": "Name of the issuing entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "ISIN of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The type of Treasury security - i.e., Bill, Note, Bond, TIPS, FRN.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_date", + "type": "date | None", + "description": "The original issue date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "maturity_date", + "type": "date | None", + "description": "The maturity date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "call_date", + "type": "date | None", + "description": "The call date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "The bid price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "offer", + "type": "float | None", + "description": "The offer price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "eod_price", + "type": "float | None", + "description": "The end-of-day price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "last_traded_date", + "type": "date | None", + "description": "The last trade date of the security.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_trades", + "type": "int | None", + "description": "Total number of trades on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last price of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "highest_price", + "type": "float | None", + "description": "The highest price for the bond on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "lowest_price", + "type": "float | None", + "description": "The lowest price for the bond on the last traded date.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "rate", + "type": "float | None", + "description": "The annualized interest rate or coupon of the security.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ytm", + "type": "float | None", + "description": "Yield to maturity (YTM) is the rate of return anticipated on a bond if it is held until the maturity date. It takes into account the current market price, par value, coupon rate and time to maturity. It is assumed that all coupons are reinvested at the same rate.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ], + "us_treasury": [ + { + "name": "date", + "type": "date | str", + "description": "The price date the quotes were sourced for.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "TreasuryPrices", + "openapi_extra": { + "model": "TreasuryPrices" + } + }, + "/ustreasury/award": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Drill into a federal award from USAspending - its summary, transactions, subawards, federal accounts, funding, or the orders placed against a vehicle.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Get the summary of an award by its usaspending.gov id.\nobb.ustreasury.award(award_id='CONT_IDV_15F06724A0000314_1549', provider='us_treasury')\n# Drill into the subawards of an award.\nobb.ustreasury.award(award_id='CONT_IDV_15F06724A0000314_1549', section='subawards', provider='us_treasury')\n# Get the orders placed against an indefinite delivery vehicle.\nobb.ustreasury.award(award_id='CONT_IDV_15F06724A0000314_1549', section='idv_children', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "award_id", + "type": "str", + "description": "The award identifier, as it appears in a usaspending.gov/award/ URL, e.g. 'CONT_IDV_15F06724A0000314_1549'. The internal integer award id is also accepted.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "section", + "type": "str | None", + "description": "The section of the award to return. 'detail' returns the award summary as a single row. 'idv_children' is only valid for IDV awards.", + "default": "detail", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "idv_children_type", + "type": "str | None", + "description": "For section='idv_children', the relation to return. 'child_awards' are the orders placed against the vehicle, 'child_idvs' are nested vehicles, and the two are disjoint sets.", + "default": "child_awards", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "page", + "type": "int | None", + "description": "The page of results to return.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. Capped by the source at 5000 for 'transactions' and 100 for every other paginated section. Ignored when section='detail'.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsSpendingAward", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "action_date", + "type": "date | None", + "description": "Date the transaction or subaward action was taken.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_id", + "type": "str", + "description": "Identifier of the award the row belongs to.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "child_award_id", + "type": "str | None", + "description": "Identifier of the child award, for section='idv_children'. Supply it back as award_id to drill into the child.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_id", + "type": "str | None", + "description": "Natural identifier of the transaction, for section='transactions'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "modification_number", + "type": "str | None", + "description": "Modification number of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subaward_id", + "type": "int | None", + "description": "Internal identifier of the subaward, for section='subawards'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subaward_number", + "type": "str | None", + "description": "Subaward number as reported by the prime recipient. Not unique - it can repeat across rows.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "piid", + "type": "str | None", + "description": "Procurement Instrument Identifier, for contracts and IDVs.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fain", + "type": "str | None", + "description": "Federal Award Identification Number, for assistance awards.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "uri", + "type": "str | None", + "description": "Unique Record Identifier, for assistance awards.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_award_id", + "type": "str | None", + "description": "Identifier of the parent IDV, when the award has one.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_piid", + "type": "str | None", + "description": "PIID of the parent IDV, when the award has one.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "internal_id", + "type": "int | None", + "description": "Internal surrogate identifier of the row's award.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "record_type", + "type": "int | None", + "description": "Assistance record type - 1 is aggregate, 2 and 3 are non-aggregate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Award category - contract, idv, grant, loans, direct payment, other, or insurance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_type", + "type": "str | None", + "description": "Award type code, e.g. 'IDV_E' or '02'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_type_description", + "type": "str | None", + "description": "Human readable award type, e.g. 'BPA'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "action_type", + "type": "str | None", + "description": "Action type code of the transaction, e.g. 'A' or 'G'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "action_type_description", + "type": "str | None", + "description": "Human readable action type of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float | None", + "description": "Face value of the subaward, in dollars, for section='subawards'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "federal_action_obligation", + "type": "float | None", + "description": "Obligation recorded by the transaction, in dollars. This is a per-modification delta and is negative for de-obligations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "obligated_amount", + "type": "float | None", + "description": "Amount obligated to the child award, in dollars, for section='idv_children'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_obligation", + "type": "float | None", + "description": "Total amount obligated to the award, in dollars. Reported as 0 for an IDV, whose obligations sit on its children.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "base_and_all_options", + "type": "float | None", + "description": "Award ceiling if all options are exercised, in dollars. Null for assistance awards.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "base_exercised_options", + "type": "float | None", + "description": "Award value including exercised options, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_outlay", + "type": "float | None", + "description": "Total amount outlayed against the award, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_account_obligation", + "type": "float | None", + "description": "Total obligation reported in the award's federal account records, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_account_outlay", + "type": "float | None", + "description": "Total outlay reported in the award's federal account records, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "subaward_count", + "type": "int | None", + "description": "Number of subawards reported under the award.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_subaward_amount", + "type": "float | None", + "description": "Total value of subawards reported under the award, in dollars. Null when there are no subawards.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_subsidy_cost", + "type": "float | None", + "description": "Total subsidy cost, in dollars. Loans only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_loan_value", + "type": "float | None", + "description": "Total face value of the loan, in dollars. Loans only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "face_value_loan_guarantee", + "type": "float | None", + "description": "Face value of the loan guarantee, in dollars. Loans only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "original_loan_subsidy_cost", + "type": "float | None", + "description": "Original subsidy cost of the loan, in dollars. Loans only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "non_federal_funding", + "type": "float | None", + "description": "Non-federal funding, in dollars. Grants only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_funding", + "type": "float | None", + "description": "Total federal and non-federal funding, in dollars. Grants only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_obligated_amount", + "type": "float | None", + "description": "Amount obligated by the funding record, in dollars. Mutually exclusive with gross_outlay_amount on a funding row.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_outlay_amount", + "type": "float | None", + "description": "Amount outlayed by the funding record, in dollars. Negative values are downward adjustments. Mutually exclusive with transaction_obligated_amount on a funding row.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_transaction_obligated_amount", + "type": "float | None", + "description": "Amount obligated from the federal account, in dollars, for section='federal_accounts'. Coalesced to 0 by the source when no funding records exist.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date_signed", + "type": "date | None", + "description": "Date the award was signed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_start", + "type": "date | None", + "description": "Start date of the period of performance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_end", + "type": "date | None", + "description": "Current end date of the period of performance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "period_potential_end", + "type": "date | None", + "description": "Potential end date of the period of performance, if all options are exercised.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_date_to_order", + "type": "date | None", + "description": "Last date an order may be placed against the vehicle, for section='idv_children'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_modified", + "type": "date | None", + "description": "Date the award record was last modified.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_name", + "type": "str | None", + "description": "Name of the recipient. For section='subawards' this is the subrecipient, otherwise the prime recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_uei", + "type": "str | None", + "description": "Unique Entity Identifier of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_recipient_name", + "type": "str | None", + "description": "Name of the recipient's parent entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "parent_recipient_uei", + "type": "str | None", + "description": "Unique Entity Identifier of the recipient's parent entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_city", + "type": "str | None", + "description": "City of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_state", + "type": "str | None", + "description": "State code of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_zip", + "type": "str | None", + "description": "Five digit ZIP code of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_country", + "type": "str | None", + "description": "Country of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_congressional_district", + "type": "str | None", + "description": "Congressional district of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "place_of_performance_city", + "type": "str | None", + "description": "City where the award is performed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "place_of_performance_state", + "type": "str | None", + "description": "State code where the award is performed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "place_of_performance_country", + "type": "str | None", + "description": "Country where the award is performed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "place_of_performance_congressional_district", + "type": "str | None", + "description": "Congressional district where the award is performed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_agency", + "type": "str | None", + "description": "Name of the awarding top-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_subagency", + "type": "str | None", + "description": "Name of the awarding sub-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_office", + "type": "str | None", + "description": "Name of the awarding office.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "funding_agency", + "type": "str | None", + "description": "Name of the funding top-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "funding_subagency", + "type": "str | None", + "description": "Name of the funding sub-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "funding_office", + "type": "str | None", + "description": "Name of the funding office.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "funding_agency_abbreviation", + "type": "str | None", + "description": "Abbreviation of the funding agency, for section='federal_accounts'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "naics", + "type": "str | None", + "description": "North American Industry Classification System code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "naics_description", + "type": "str | None", + "description": "Description of the NAICS code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "psc", + "type": "str | None", + "description": "Product or Service Code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "psc_description", + "type": "str | None", + "description": "Description of the Product or Service Code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cfda_number", + "type": "str | None", + "description": "Assistance Listing (CFDA) number. Assistance awards only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cfda_title", + "type": "str | None", + "description": "Assistance Listing (CFDA) title. Assistance awards only.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "federal_account", + "type": "str | None", + "description": "Federal account identifier, as '-
'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "account_title", + "type": "str | None", + "description": "Title of the federal account.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "disaster_emergency_fund_code", + "type": "str | None", + "description": "Disaster Emergency Fund Code, where 'Q' is non-disaster funding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "object_class", + "type": "str | None", + "description": "Object class code, e.g. '25.1'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "object_class_name", + "type": "str | None", + "description": "Name of the object class.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "program_activity_code", + "type": "str | None", + "description": "Program activity code.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "program_activity_name", + "type": "str | None", + "description": "Name of the program activity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reporting_fiscal_year", + "type": "int | None", + "description": "Federal fiscal year of the submission.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reporting_fiscal_quarter", + "type": "int | None", + "description": "Federal fiscal quarter of the submission.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "reporting_fiscal_month", + "type": "int | None", + "description": "Federal fiscal month of the submission, where 1 is October and 12 is September.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "is_quarterly_submission", + "type": "bool | None", + "description": "True when the submission is quarterly, False when monthly.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the award, transaction, or subaward.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "UsSpendingAward", + "openapi_extra": { + "model": "UsSpendingAward" + } + }, + "/ustreasury/spending_explorer": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Explore all federal spending for a fiscal year, broken down by budget function, agency, federal account, program activity, object class, recipient, or award.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Break all federal spending down by object class.\nobb.ustreasury.spending_explorer(provider='us_treasury')\n# Drill into the agencies acquiring assets.\nobb.ustreasury.spending_explorer(explorer_type='agency', scope='object_class:30', provider='us_treasury')\n# Drill into one agency's federal accounts for an object class.\nobb.ustreasury.spending_explorer(explorer_type='federal_account', scope='agency:1173', object_class='30', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "explorer_type", + "type": "str | None", + "description": "Dimension to break the spending down by. Every dimension works on its own except 'program_activity', 'recipient', 'award', 'award_category', which are too large to enumerate government-wide and need a scoping filter. A scope on the dimension being broken down is ignored, since breaking down by a dimension means showing every one of its entries.", + "default": "object_class", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Breakdown By", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/explorer_types", + "optionsParams": { + "budget_function": "$budget_function", + "budget_subfunction": "$budget_subfunction", + "agency": "$agency", + "federal_account": "$federal_account", + "program_activity": "$program_activity", + "object_class": "$object_class", + "recipient": "$recipient" + }, + "style": { + "popupWidth": 380 + } + } + } + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "Federal fiscal year. When None, the most recent year the source has published is used. Data begins in FY2017 Q2.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Fiscal Year", + "type": "number" + } + } + }, + { + "name": "period", + "type": "str | None", + "description": "Federal fiscal period to report through. Amounts are cumulative from the start of the fiscal year, so 'Through March' covers October through March. 'latest' resolves to the most recent period the source has published, because a period that has not closed yet is rejected.", + "default": "latest", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Reporting Period", + "multiSelect": false, + "multiple": false, + "options": [ + { + "label": "Latest available", + "value": "latest" + }, + { + "label": "Through November", + "value": "2" + }, + { + "label": "Through December (Q1)", + "value": "3" + }, + { + "label": "Through January", + "value": "4" + }, + { + "label": "Through February", + "value": "5" + }, + { + "label": "Through March (Q2)", + "value": "6" + }, + { + "label": "Through April", + "value": "7" + }, + { + "label": "Through May", + "value": "8" + }, + { + "label": "Through June (Q3)", + "value": "9" + }, + { + "label": "Through July", + "value": "10" + }, + { + "label": "Through August", + "value": "11" + }, + { + "label": "Through September (Q4)", + "value": "12" + } + ], + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "budget_function", + "type": "str | None", + "description": "Scope the breakdown to one budget function, by its code.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Budget Function", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/spending_options", + "optionsParams": { + "dimension": "budget_function" + }, + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "budget_subfunction", + "type": "str | None", + "description": "Scope the breakdown to one budget sub-function, by its code.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Budget Subfunction", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/spending_options", + "optionsParams": { + "dimension": "budget_subfunction" + }, + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "agency", + "type": "str | None", + "description": "Scope the breakdown to one agency, by the id returned for an 'agency' breakdown.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Agency", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/spending_options", + "optionsParams": { + "dimension": "agency" + }, + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "federal_account", + "type": "str | None", + "description": "Scope the breakdown to one federal account, by the id returned for a 'federal_account' breakdown.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Federal Account", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/spending_options", + "optionsParams": { + "dimension": "federal_account", + "agency": "$agency" + }, + "style": { + "popupWidth": 560 + } + } + } + }, + { + "name": "program_activity", + "type": "str | None", + "description": "Scope the breakdown to one program activity, by its id.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "object_class", + "type": "str | None", + "description": "Scope the breakdown to one object class, by its code, e.g. '30' for Acquisition of assets.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Object Class", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/spending_options", + "optionsParams": { + "dimension": "object_class" + }, + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "recipient", + "type": "str | None", + "description": "Scope the breakdown to one recipient, by its id.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsSpendingExplorer", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "name", + "type": "str | None", + "description": "Name of the breakdown entry.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "pinned": "left" + } + } + }, + { + "name": "amount", + "type": "float | None", + "description": "Obligated amount, in dollars, cumulative through the requested period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_of_total", + "type": "float | None", + "description": "The entry's share of the breakdown total, as a percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "suffix": "%" + } + } + }, + { + "name": "code", + "type": "str | None", + "description": "Code of the breakdown entry, where the dimension has one.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "account_number", + "type": "str | None", + "description": "Federal account symbol, for a 'federal_account' breakdown.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "explorer_id", + "type": "str | None", + "description": "Identifier of the entry within its dimension, as the matching scope filter accepts it.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "headerName": "ID" + } + } + }, + { + "name": "as_of_date", + "type": "str | None", + "description": "Date the reported data is current as of.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-widget_config": { + "hide": true + } + } + } + ] + }, + "model": "UsSpendingExplorer", + "openapi_extra": { + "model": "UsSpendingExplorer" + } + }, + "/ustreasury/recipient_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search every entity that has received federal contract or assistance money, by name, UEI, or legacy DUNS.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Find a recipient by name.\nobb.ustreasury.recipient_search(keyword='Lockheed Martin', provider='us_treasury')\n# Look a recipient up by its UEI or legacy DUNS.\nobb.ustreasury.recipient_search(keyword='ZFN2JJXBLZT3', provider='us_treasury')\n# Rank the largest grant recipients.\nobb.ustreasury.recipient_search(award_type='grants', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "keyword", + "type": "str | None", + "description": "Search text matched against the recipient name, UEI, or legacy DUNS. Matching is case-insensitive and by prefix, so a partial name or identifier is accepted. When None, the entire recipient list is returned, ordered by the sort parameters.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Search" + } + } + }, + { + "name": "award_type", + "type": "str | None", + "description": "Award category the recipient's amount is measured over. Changes both the set of recipients returned and the amount reported for each.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Award Type", + "multiSelect": false, + "multiple": false, + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "sort", + "type": "str | None", + "description": "Field to sort the results by.", + "default": "amount", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Sort By", + "multiSelect": false, + "multiple": false + } + } + }, + { + "name": "order", + "type": "str | None", + "description": "Sort order.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Order", + "multiSelect": false + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. Capped by the source at 1000.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "page", + "type": "int | None", + "description": "The page of results.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsSpendingRecipientSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "recipient_id", + "type": "str", + "description": "Identifier of the recipient at this level, used to look up the recipient's profile and awards.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Recipient", + "headerTooltip": "Click a cell here to group by this recipient and drive the 'Federal Recipient Info' and 'Recipient Awards' widgets.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "recipient_id" + } + } + } + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_level", + "type": "str | None", + "description": "Whether the recipient is a Parent, a Child, or neither.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "uei", + "type": "str | None", + "description": "Unique Entity Identifier of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "duns", + "type": "str | None", + "description": "Legacy DUNS number of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float | None", + "description": "Aggregate value of the recipient's transactions over the trailing 12 months, in dollars. Negative when de-obligations exceed obligations.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "UsSpendingRecipientSearch", + "openapi_extra": { + "model": "UsSpendingRecipientSearch" + } + }, + "/ustreasury/recipient_awards": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the federal awards belonging to one recipient, then drill into any award by its id.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# List a recipient's largest contracts.\nobb.ustreasury.recipient_awards(recipient_id='b97d19b0-833c-8d8f-3a2c-157d04ea55ef-P', provider='us_treasury')\n# List a recipient's grants.\nobb.ustreasury.recipient_awards(recipient_id='ab4b0d9e-2a56-a67b-1fb7-b54a68b680ed-P', award_group='grants', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "recipient_id", + "type": "str", + "description": "Identifier of the recipient, as returned by the recipient search, e.g. 'ab4b0d9e-2a56-a67b-1fb7-b54a68b680ed-P'. A parent level identifier rolls up the awards of every subsidiary.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Recipient ID" + } + } + }, + { + "name": "award_group", + "type": "str | None", + "description": "Award category to list.", + "default": "contracts", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Award Group", + "multiSelect": false, + "multiple": false, + "style": { + "popupWidth": 300 + } + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. Capped by the source at 100.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "page", + "type": "int | None", + "description": "The page of results.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsSpendingRecipientAwards", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "award_id", + "type": "str", + "description": "Identifier of the award, used to look up the award detail.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "\u25b8 Group: Award ID", + "headerTooltip": "Click a cell here to group by this award and drive the 'Federal Award Info' widget.", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "award_id" + } + } + } + }, + { + "name": "award_number", + "type": "str | None", + "description": "The award's public identifier, its PIID, FAIN, or URI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_name", + "type": "str | None", + "description": "Name of the recipient on the award.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_uei", + "type": "str | None", + "description": "Unique Entity Identifier of the recipient on the award.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_type", + "type": "str | None", + "description": "Human readable award type.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_amount", + "type": "float | None", + "description": "Current total value of the award, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_outlays", + "type": "float | None", + "description": "Total outlayed against the award, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_agency", + "type": "str | None", + "description": "Name of the awarding top-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_subagency", + "type": "str | None", + "description": "Name of the awarding sub-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the period of performance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the period of performance.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the award.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "UsSpendingRecipientAwards", + "openapi_extra": { + "model": "UsSpendingRecipientAwards" + } + }, + "/ustreasury/dts_amount_bases": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the amount bases a Daily Treasury Statement table publishes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "", + "default": "operating_cash_balance", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/ustreasury/explorer_types": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the breakdowns that work for the current scope.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "budget_function", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "budget_subfunction", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "agency", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "federal_account", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "program_activity", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "object_class", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "recipient", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/ustreasury/spending_options": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the selectable entries of one spending dimension.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "dimension", + "type": "str", + "description": "", + "default": "agency", + "optional": true + }, + { + "name": "agency", + "type": "str", + "description": "", + "default": null, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/ustreasury/awarding_agencies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the top-tier awarding agencies.\n\n Returns\n -------\n list", + "examples": "", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/ustreasury/def_codes": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the Disaster Emergency Fund Codes as widget options.\n\n Returns\n -------\n list", + "examples": "", + "parameters": { + "standard": [] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/ustreasury/dts_sub_tables": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "List the sub-tables of one Daily Treasury Statement table.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "table", + "type": "str", + "description": "", + "default": "operating_cash_balance", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + } + } + }, + "/ustreasury/recipient_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render one federal recipient's profile (OpenBB Workspace HTML widget).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "recipient_id", + "type": "str", + "description": "", + "default": null, + "optional": false + }, + { + "name": "year", + "type": "str", + "description": "", + "default": "latest", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Federal Recipient Info", + "description": "Profile of a single federal award recipient from USAspending.gov - identity, location, totals, top awarding agencies, federal accounts, assistance listings, and geography, plus its child recipients.", + "category": "Government", + "subCategory": "Federal Awards", + "source": [ + "US Treasury", + "USAspending" + ], + "type": "html", + "raw": true, + "widgetId": "ustreasury_recipient_info_us_treasury_obb", + "gridData": { + "w": 20, + "h": 20 + }, + "params": [ + { + "paramName": "recipient_id", + "label": "Recipient ID", + "description": "The recipient identifier, as returned by the recipient search, e.g. 'ab4b0d9e-2a56-a67b-1fb7-b54a68b680ed-P'.", + "type": "text", + "value": "ab4b0d9e-2a56-a67b-1fb7-b54a68b680ed-P", + "show": true + }, + { + "paramName": "year", + "label": "Period", + "type": "text", + "value": "latest", + "show": true, + "multiSelect": false, + "options": [ + { + "label": "Trailing 12 months", + "value": "latest" + }, + { + "label": "All time", + "value": "all" + } + ] + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false + } + } + }, + "/ustreasury/award_info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Render one federal award's summary and subawards (OpenBB Workspace HTML widget).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "award_id", + "type": "str", + "description": "", + "default": null, + "optional": false + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Federal Award Info", + "description": "Summary of a single federal contract or assistance award from USAspending.gov - amounts, period of performance, recipient, place of performance, agencies, and classification.", + "category": "Government", + "subCategory": "Federal Awards", + "source": [ + "US Treasury", + "USAspending" + ], + "type": "html", + "raw": true, + "widgetId": "ustreasury_award_info_us_treasury_obb", + "gridData": { + "w": 20, + "h": 20 + }, + "params": [ + { + "paramName": "award_id", + "label": "Award ID", + "description": "The award identifier, as it appears in a usaspending.gov/award/ URL.", + "type": "text", + "value": "CONT_IDV_15F06724A0000314_1549", + "show": true + }, + { + "paramName": "raw", + "show": false + } + ], + "refetchInterval": false + } + } + }, + "/ustreasury/award_search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search federal contract and assistance awards from USAspending by agency, recipient, keyword, amount, and date, then drill into any award by its id.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Search the largest recent defense contracts.\nobb.ustreasury.award_search(award_group='contracts', agency='Department of Defense', provider='us_treasury')\n# Find recent grants to a recipient by keyword.\nobb.ustreasury.award_search(award_group='grants', recipient='California', keywords='medicaid', provider='us_treasury')\n```\n\n", + "parameters": { + "standard": [], + "us_treasury": [ + { + "name": "award_group", + "type": "str | None", + "description": "Award family to search: 'contracts', 'idvs' (indefinite delivery vehicles), 'grants', 'direct_payments', 'loans', or 'other_assistance'. Sets the underlying award-type codes.", + "default": "contracts", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Award Group", + "multiSelect": false, + "multiple": false + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format. Filters on the award action period. When None, defaults to the trailing 365 days rather than all of history.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format. Filters on the award action period.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "keywords", + "type": "str | None", + "description": "Free-text search over award descriptions and identifiers. Accepts a comma-separated list; awards matching any term are kept.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "recipient", + "type": "str | None", + "description": "Recipient name search text, e.g. 'Boeing'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "agency", + "type": "str | None", + "description": "Awarding top-tier agency name, exactly as published, e.g. 'Department of Defense'.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Awarding Agency", + "type": "endpoint", + "multiSelect": false, + "multiple": false, + "optionsEndpoint": "/api/v1/ustreasury/awarding_agencies", + "options": [ + { + "label": "Awarding Agency", + "value": "none" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "min_amount", + "type": "float | None", + "description": "Minimum award amount, in dollars.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "max_amount", + "type": "float | None", + "description": "Maximum award amount, in dollars.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "award_number", + "type": "str | None", + "description": "Award number, its PIID, FAIN, or URI, e.g. 'SPE30018FLGFZ'. Accepts a comma-separated list. Matching is fuzzy; wrap a value in double quotes for an exact match, which is needed for identifiers containing spaces.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Award Number (PIID/FAIN)" + } + } + }, + { + "name": "description", + "type": "str | None", + "description": "Search text matched against the award description only, unlike 'keywords', which also searches identifiers.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Award Description" + } + } + }, + { + "name": "naics", + "type": "str | None", + "description": "North American Industry Classification System code, e.g. '541519'. Accepts a comma-separated list. Validated against the source's reference list.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "NAICS" + } + } + }, + { + "name": "psc", + "type": "str | None", + "description": "Product or Service Code, e.g. 'R425'. Accepts a comma-separated list. Validated against the source's reference list.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "PSC" + } + } + }, + { + "name": "assistance_listing", + "type": "str | None", + "description": "Assistance Listing (CFDA) program number, e.g. '10.331'. Accepts a comma-separated list. Validated against the source's reference list. Assistance awards only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Assistance Listing" + } + } + }, + { + "name": "defc", + "type": "str | None", + "description": "Disaster Emergency Fund Code, e.g. 'L' for COVID-19 or 'Z' for infrastructure. Accepts a comma-separated list.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "DEFC", + "multiSelect": true, + "type": "endpoint", + "optionsEndpoint": "/api/v1/ustreasury/def_codes", + "options": [ + { + "label": "DEFC", + "value": "none" + } + ], + "style": { + "popupWidth": 520 + } + } + } + }, + { + "name": "contract_pricing", + "type": "str | None", + "description": "Type of contract pricing, by code, e.g. 'J' for Firm Fixed Price. Accepts a comma-separated list. Contracts and IDVs only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Contract Pricing", + "multiSelect": true, + "options": [ + { + "label": "Contract Pricing", + "value": "none" + }, + { + "label": "Fixed Price Redetermination (A)", + "value": "A" + }, + { + "label": "Fixed Price Level of Effort (B)", + "value": "B" + }, + { + "label": "Firm Fixed Price (J)", + "value": "J" + }, + { + "label": "Fixed Price with Economic Price Adjustment (K)", + "value": "K" + }, + { + "label": "Fixed Price Incentive (L)", + "value": "L" + }, + { + "label": "Fixed Price Award Fee (M)", + "value": "M" + }, + { + "label": "Cost Plus Award Fee (R)", + "value": "R" + }, + { + "label": "Cost No Fee (S)", + "value": "S" + }, + { + "label": "Cost Sharing (T)", + "value": "T" + }, + { + "label": "Cost Plus Fixed Fee (U)", + "value": "U" + }, + { + "label": "Cost Plus Incentive Fee (V)", + "value": "V" + }, + { + "label": "Time and Materials (Y)", + "value": "Y" + }, + { + "label": "Labor Hours (Z)", + "value": "Z" + }, + { + "label": "Order Dependent (1)", + "value": "1" + }, + { + "label": "Combination (2)", + "value": "2" + }, + { + "label": "Other (3)", + "value": "3" + } + ], + "style": { + "popupWidth": 460 + } + } + } + }, + { + "name": "set_aside", + "type": "str | None", + "description": "Type of set aside, by code, e.g. 'SBA' for Small Business Set Aside - Total. Accepts a comma-separated list. Contracts and IDVs only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Set Aside", + "multiSelect": true, + "options": [ + { + "label": "Set Aside", + "value": "none" + }, + { + "label": "8(a) Competed (8A)", + "value": "8A" + }, + { + "label": "8(a) Sole Source (8AN)", + "value": "8AN" + }, + { + "label": "SDB Set Aside 8(a) (8ACCiv)", + "value": "8ACCiv" + }, + { + "label": "8(a) with HUBZone Preference (HS3)", + "value": "HS3" + }, + { + "label": "Combination HUBZone and 8(a) (HS2Civ)", + "value": "HS2Civ" + }, + { + "label": "HUBZone Set Aside (HZC)", + "value": "HZC" + }, + { + "label": "HUBZone Sole Source (HZS)", + "value": "HZS" + }, + { + "label": "HBCU or MI Set Aside - Partial (HMP)", + "value": "HMP" + }, + { + "label": "HBCU or MI Set Aside - Total (HMT)", + "value": "HMT" + }, + { + "label": "Buy Indian (BI)", + "value": "BI" + }, + { + "label": "Indian Economic Enterprise (ISEE)", + "value": "ISEE" + }, + { + "label": "Indian Small Business Economic Enterprise (ISBEE)", + "value": "ISBEE" + }, + { + "label": "Economically-Disadvantaged Women-Owned Small Business (EDWOSB)", + "value": "EDWOSB" + }, + { + "label": "Economically Disadvantaged Women Owned Small Business Sole Source (EDWOSBSS)", + "value": "EDWOSBSS" + }, + { + "label": "Women-Owned Small Business (WOSB)", + "value": "WOSB" + }, + { + "label": "Women Owned Small Business Sole Source (WOSBSS)", + "value": "WOSBSS" + }, + { + "label": "Service-Disabled Veteran-Owned Small Business Set Aside (SDVOSBC)", + "value": "SDVOSBC" + }, + { + "label": "SDVOSB Sole Source (SDVOSBS)", + "value": "SDVOSBS" + }, + { + "label": "Veteran Set Aside (VSA)", + "value": "VSA" + }, + { + "label": "Veteran Sole Source (VSS)", + "value": "VSS" + }, + { + "label": "Small Business Set Aside - Total (SBA)", + "value": "SBA" + }, + { + "label": "Small Business Set Aside - Partial (SBP)", + "value": "SBP" + }, + { + "label": "Emerging Small Business Set Aside (ESB)", + "value": "ESB" + }, + { + "label": "Reserved for Small Business $2,501 to $100K (RSBCiv)", + "value": "RSBCiv" + }, + { + "label": "Very Small Business Set Aside (VSBCiv)", + "value": "VSBCiv" + }, + { + "label": "No Set Aside Used (NONE)", + "value": "NONE" + } + ], + "style": { + "popupWidth": 460 + } + } + } + }, + { + "name": "extent_competed", + "type": "str | None", + "description": "Extent competed, by code, e.g. 'A' for Full and Open Competition. Accepts a comma-separated list. Contracts and IDVs only.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "label": "Extent Competed", + "multiSelect": true, + "options": [ + { + "label": "Extent Competed", + "value": "none" + }, + { + "label": "Full and Open Competition (A)", + "value": "A" + }, + { + "label": "Full and Open Competition after exclusion of sources (D)", + "value": "D" + }, + { + "label": "Competed under SAP (F)", + "value": "F" + }, + { + "label": "Competitive Delivery Order (CDOCiv)", + "value": "CDOCiv" + }, + { + "label": "Follow On to Competed Action (E Civ)", + "value": "E Civ" + }, + { + "label": "Not Available for Competition (B)", + "value": "B" + }, + { + "label": "Not Competed (C)", + "value": "C" + }, + { + "label": "Not Competed under SAP (G)", + "value": "G" + }, + { + "label": "Non-Competitive Delivery Order (NDOCiv)", + "value": "NDOCiv" + } + ], + "style": { + "popupWidth": 460 + } + } + } + }, + { + "name": "sort", + "type": "str | None", + "description": "Field to sort by.", + "default": "Award Amount", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "order", + "type": "str | None", + "description": "Sort order.", + "default": "desc", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "page", + "type": "int | None", + "description": "The page of results to return.", + "default": 1, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return. Capped by the source at 100.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "UsSpendingAwardSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "us_treasury": [ + { + "name": "award_id", + "type": "str", + "description": "USAspending award identifier, as used by the award drill-down, e.g. 'CONT_AWD_HT940216C0001_9700_-NONE-_-NONE-'. Click it to open the award in the drill-down widgets.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "headerName": "Award ID", + "pinned": "left", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "award_id" + } + } + } + }, + { + "name": "award_number", + "type": "str | None", + "description": "Published award number: the contract PIID, or the assistance FAIN or URI.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_name", + "type": "str | None", + "description": "Name of the award recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_uei", + "type": "str | None", + "description": "Unique Entity Identifier of the recipient.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_type", + "type": "str | None", + "description": "Award type, e.g. 'DEFINITIVE CONTRACT' or 'BLOCK GRANT (A)'.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "award_amount", + "type": "float | None", + "description": "Current total award amount, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_outlays", + "type": "float | None", + "description": "Total outlays paid against the award, in dollars.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_agency", + "type": "str | None", + "description": "Awarding top-tier agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "awarding_sub_agency", + "type": "str | None", + "description": "Awarding sub-agency.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Period-of-performance start date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "Period-of-performance current end date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Award description.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recipient_id", + "type": "str | None", + "description": "Internal recipient identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "internal_id", + "type": "int | None", + "description": "Internal award identifier.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "UsSpendingAwardSearch", + "openapi_extra": { + "model": "UsSpendingAwardSearch" + } + }, + "/yfinance/search": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search Yahoo Finance for symbols, optionally narrowing by asset type.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.search(query='apple', provider='yfinance')\n# Narrow the search to a single asset type.\nobb.yfinance.search(query='growth', asset_type='mutualfund', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "query", + "type": "str | None", + "description": "Search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Restrict the search to a single asset type. Empty searches all.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of results to return.", + "default": 30, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfSymbolSearch", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "A short description of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the asset trades on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "The type of asset (equity, etf, index, etc.).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfSymbolSearch", + "openapi_extra": { + "widget_config": { + "name": "Yahoo Finance Symbol Search", + "description": "Search Yahoo Finance for symbols; click a symbol in the table to change the grouped widgets' symbol.", + "type": "table", + "category": "Equity", + "subCategory": "Search", + "widgetId": "yfinance_search_obb", + "gridData": { + "w": 14, + "h": 11 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "symbol", + "headerName": "Symbol", + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupByParamName": "symbol" + } + }, + { + "field": "name", + "headerName": "Name" + }, + { + "field": "exchange", + "headerName": "Exchange" + }, + { + "field": "asset_type", + "headerName": "Type" + } + ] + } + } + }, + "model": "YfSymbolSearch" + } + }, + "/yfinance/industry_choices": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Return Yahoo industry choices for a sector to drive cascading dropdowns.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "sector", + "type": "str", + "description": "", + "default": null, + "optional": true + }, + { + "name": "is_workspace", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "provider", + "type": "str", + "description": "", + "default": "yfinance", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/yfinance/news": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Search Yahoo Finance news by free-text query or symbol.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.news(query='federal reserve', provider='yfinance')\nobb.yfinance.news(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "query", + "type": "str | None", + "description": "Free-text news search query.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "A ticker symbol to fetch news for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of results to return.", + "default": 20, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fetch_body", + "type": "bool | None", + "description": "Fetch the full article body for each result. Disable for a faster response with only the headline and excerpt.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfNews", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "title", + "type": "str", + "description": "The title of the article.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "datetime | None | str", + "description": "The date the article was published.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "author", + "type": "str | None", + "description": "The publisher/author of the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "excerpt", + "type": "str | None", + "description": "A short preview of the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "body", + "type": "str | None", + "description": "The full article body, as markdown text.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The URL to the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbols", + "type": "str | None", + "description": "Comma-separated symbols related to the article.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfNews", + "openapi_extra": { + "widget_config": { + "name": "Yahoo Finance News", + "description": "Yahoo Finance news with the full article body.", + "type": "newsfeed", + "category": "News", + "widgetId": "yfinance_news_obb", + "gridData": { + "w": 12, + "h": 10 + } + }, + "model": "YfNews" + } + }, + "/yfinance/private_companies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get private-company markets from Yahoo Finance (Crunchbase data).", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.private_companies(category='highest_valuation', provider='yfinance')\nobb.yfinance.private_companies(category='most_funded', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "category", + "type": "str | None", + "description": "The private-companies market to retrieve.", + "default": "highest_valuation", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of companies to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfPrivateCompanies", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The Yahoo private-company symbol (e.g. ANTH.PVT).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The company name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "valuation", + "type": "float | None", + "description": "The latest implied valuation.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "funding_to_date", + "type": "float | None", + "description": "The total funding raised to date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_amount_raised", + "type": "float | None", + "description": "The amount raised in the latest funding round.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_funding_date", + "type": "date | None", + "description": "The date of the latest funding round.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_share_class", + "type": "str | None", + "description": "The latest share class issued.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lead_investor", + "type": "str | None", + "description": "The lead investor of the latest round.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_funding_rounds", + "type": "int | None", + "description": "The total number of funding rounds.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_52_week", + "type": "float | None", + "description": "The 52-week change in the indexed price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 1 + } + }, + { + "name": "price", + "type": "float | None", + "description": "The latest indexed private-company price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employees", + "type": "int | None", + "description": "The number of full-time employees.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date_founded", + "type": "date | None", + "description": "The date the company was founded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The company sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry", + "type": "str | None", + "description": "The company industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "city", + "type": "str | None", + "description": "The headquarters city.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "state", + "type": "str | None", + "description": "The headquarters state.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "The headquarters country.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "The company website.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lead_executives", + "type": "str | None", + "description": "Comma-separated lead executives and titles.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "summary", + "type": "str | None", + "description": "A short business summary of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfPrivateCompanies", + "openapi_extra": { + "widget_config": { + "name": "Yahoo Finance Private Companies", + "description": "Private-company markets from Yahoo Finance (Crunchbase data): valuation, funding, investors and more.", + "type": "table", + "category": "Equity", + "subCategory": "Private Companies", + "widgetId": "yfinance_private_companies_obb", + "gridData": { + "w": 40, + "h": 15 + }, + "data": { + "table": { + "columnsDefs": [ + { + "field": "name", + "headerName": "Company", + "pinned": "left", + "width": 170 + }, + { + "field": "valuation", + "headerName": "Valuation", + "cellDataType": "number" + }, + { + "field": "funding_to_date", + "headerName": "Funding to Date", + "cellDataType": "number" + }, + { + "field": "latest_amount_raised", + "headerName": "Latest Round", + "cellDataType": "number" + }, + { + "field": "latest_funding_date", + "headerName": "Last Funded" + }, + { + "field": "lead_investor", + "headerName": "Lead Investor" + }, + { + "field": "total_funding_rounds", + "headerName": "Rounds", + "cellDataType": "number" + }, + { + "field": "change_52_week", + "headerName": "52W Change %", + "cellDataType": "number" + }, + { + "field": "sector", + "headerName": "Sector" + }, + { + "field": "employees", + "headerName": "Employees", + "cellDataType": "number" + }, + { + "field": "date_founded", + "headerName": "Founded" + }, + { + "field": "website", + "headerName": "Website" + } + ] + } + } + }, + "model": "YfPrivateCompanies" + } + }, + "/yfinance/company_calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the upcoming earnings and dividend dates for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.company_calendar(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCompanyCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "earnings_date", + "type": "date | None", + "description": "The next earnings report date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ex_dividend_date", + "type": "date | None", + "description": "The next ex-dividend date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_date", + "type": "date | None", + "description": "The next dividend payment date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_high", + "type": "float | None", + "description": "The high end of the EPS estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_low", + "type": "float | None", + "description": "The low end of the EPS estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_average", + "type": "float | None", + "description": "The average EPS estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_high", + "type": "float | None", + "description": "The high end of the revenue estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_low", + "type": "float | None", + "description": "The low end of the revenue estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_average", + "type": "float | None", + "description": "The average revenue estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfCompanyCalendar", + "openapi_extra": { + "model": "YfCompanyCalendar" + } + }, + "/yfinance/funds/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the profile and operations overview for a mutual fund or ETF.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.info(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The fund or ETF ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Morningstar category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "family", + "type": "str | None", + "description": "The fund family.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legal_type", + "type": "str | None", + "description": "The legal type of fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "A description of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annual_report_expense_ratio", + "type": "float | None", + "description": "Annual report expense ratio.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "annual_report_expense_ratio_category", + "type": "float | None", + "description": "Category average annual report expense ratio.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "annual_holdings_turnover", + "type": "float | None", + "description": "Annual holdings turnover.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "annual_holdings_turnover_category", + "type": "float | None", + "description": "Category average annual holdings turnover.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "total_net_assets", + "type": "float | None", + "description": "Total net assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_earnings", + "type": "float | None", + "description": "Portfolio weighted average price-to-earnings ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_book", + "type": "float | None", + "description": "Portfolio weighted average price-to-book ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_sales", + "type": "float | None", + "description": "Portfolio weighted average price-to-sales ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_cashflow", + "type": "float | None", + "description": "Portfolio weighted average price-to-cashflow ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "median_market_cap", + "type": "float | None", + "description": "Median market capitalization of holdings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "three_year_earnings_growth", + "type": "float | None", + "description": "Three year earnings growth of holdings.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bond_duration", + "type": "float | None", + "description": "Average bond duration, in years.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bond_maturity", + "type": "float | None", + "description": "Average bond maturity, in years.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bond_credit_quality", + "type": "float | str | None", + "description": "Average bond credit quality.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfFundInfo", + "openapi_extra": { + "model": "YfFundInfo" + } + }, + "/yfinance/funds/holdings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top holdings for a mutual fund or ETF.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.holdings(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundHoldings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The holding's ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the holding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "The weight of the holding in the fund.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "fund", + "type": "str | None", + "description": "The parent fund or ETF ticker symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfFundHoldings", + "openapi_extra": { + "model": "YfFundHoldings" + } + }, + "/yfinance/funds/allocation": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the asset-class, sector and bond-rating allocation for a fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.allocation(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "breakdown", + "type": "str | None", + "description": "The allocation breakdown to return.", + "default": "all", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundAllocation", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The fund or ETF ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "breakdown", + "type": "str", + "description": "The breakdown type (asset_class, sector, or bond_rating).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "The allocation category name.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "weight", + "type": "float | None", + "description": "The weight of the category.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "YfFundAllocation", + "openapi_extra": { + "model": "YfFundAllocation" + } + }, + "/yfinance/funds/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical NAV/price data for a mutual fund or ETF.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.historical(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [ + "1d", + "5d", + "1W", + "1M", + "1Q" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "date", + "type": "Any | date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol, when multiple are requested.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfFundHistorical", + "openapi_extra": { + "model": "YfFundHistorical" + } + }, + "/yfinance/funds/performance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get return performance and category comparisons for a fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.performance(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundPerformance", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The fund or ETF ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "measure", + "type": "str", + "description": "The measure: 'trailing_return' or 'annual_return'.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "A trailing window (1m, 3m, 6m, ytd, 1y, 3y, 5y, 10y) or a calendar year for annual returns.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "cumulative_return", + "type": "float | None", + "description": "Total return over the period.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "annualized_return", + "type": "float | None", + "description": "Annualized return over the period, for trailing windows of one year or more.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "YfFundPerformance", + "openapi_extra": { + "model": "YfFundPerformance" + } + }, + "/yfinance/funds/ratings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get Morningstar ratings and the style box for a fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.ratings(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundRatings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The fund or ETF ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "morningstar_overall_rating", + "type": "int | None", + "description": "Morningstar overall rating (1-5 stars).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "morningstar_risk_rating", + "type": "int | None", + "description": "Morningstar risk rating (1-5).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Morningstar category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "family", + "type": "str | None", + "description": "The fund family.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legal_type", + "type": "str | None", + "description": "The legal type of fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box", + "type": "int | None", + "description": "Morningstar style-box cell position (1-9), numbered left-to-right then top-to-bottom.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_type", + "type": "str | None", + "description": "The style-box type ('equity' or 'fixed_income').", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_label", + "type": "str | None", + "description": "Human-readable style-box label.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_size", + "type": "str | None", + "description": "Equity style box market-cap row (Large, Mid, Small).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_investment_style", + "type": "str | None", + "description": "Equity style box investment-style column (Value, Blend, Growth).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_credit_quality", + "type": "str | None", + "description": "Fixed-income style box credit-quality row (High, Medium, Low).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_interest_rate_sensitivity", + "type": "str | None", + "description": "Fixed-income style box interest-rate-sensitivity column (Limited, Moderate, Extensive).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "style_box_url", + "type": "str | None", + "description": "URL to the Morningstar style-box image.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfFundRatings", + "openapi_extra": { + "model": "YfFundRatings" + } + }, + "/yfinance/funds/risk": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Compute volatility, beta, Sharpe ratio and drawdown for a fund.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.funds.risk(symbol='VTSAX', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The fund or ETF ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "benchmark", + "type": "str | None", + "description": "The benchmark symbol used to compute beta.", + "default": "^GSPC", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "risk_free_rate", + "type": "float | None", + "description": "The annual risk-free rate used for the Sharpe ratio, as a decimal.", + "default": 0.0, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFundRisk", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The fund or ETF ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the analysis window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the analysis window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volatility", + "type": "float | None", + "description": "Annualized volatility of daily returns.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "beta", + "type": "float | None", + "description": "Beta versus the benchmark.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "annualized_return", + "type": "float | None", + "description": "Annualized return over the window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sharpe_ratio", + "type": "float | None", + "description": "The Sharpe ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "max_drawdown", + "type": "float | None", + "description": "The maximum drawdown over the window.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "benchmark", + "type": "str | None", + "description": "The benchmark used to compute beta.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfFundRisk", + "openapi_extra": { + "model": "YfFundRisk" + } + }, + "/yfinance/estimates/recommendations": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the analyst recommendation trends for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.estimates.recommendations(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfAnalystRecommendations", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The recommendation-trend period (e.g. 0m, -1m, -2m, -3m).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "strong_buy", + "type": "int | None", + "description": "Number of strong buy recommendations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "buy", + "type": "int | None", + "description": "Number of buy recommendations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hold", + "type": "int | None", + "description": "Number of hold recommendations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sell", + "type": "int | None", + "description": "Number of sell recommendations.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "strong_sell", + "type": "int | None", + "description": "Number of strong sell recommendations.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfAnalystRecommendations", + "openapi_extra": { + "model": "YfAnalystRecommendations" + } + }, + "/yfinance/estimates/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the forward earnings-per-share estimates for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.estimates.earnings(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEarningsEstimates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The estimate period label (e.g. 0q, +1q, 0y, +1y).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mean", + "type": "float | None", + "description": "Mean estimated EPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "Low estimated EPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "High estimated EPS.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_analysts", + "type": "int | None", + "description": "Number of analysts providing estimates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_ago_eps", + "type": "float | None", + "description": "EPS a year ago.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "growth", + "type": "float | None", + "description": "Estimated EPS growth.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the values.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEarningsEstimates", + "openapi_extra": { + "model": "YfEarningsEstimates" + } + }, + "/yfinance/estimates/revenue": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the forward revenue estimates for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.estimates.revenue(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfRevenueEstimates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The estimate period (e.g. 0q, +1q, 0y, +1y).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "mean", + "type": "float | None", + "description": "The mean revenue estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low revenue estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high revenue estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_analysts", + "type": "int | None", + "description": "The number of analysts providing estimates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_ago_revenue", + "type": "float | None", + "description": "The revenue from the year-ago period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "growth", + "type": "float | None", + "description": "The estimated revenue growth.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the values.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfRevenueEstimates", + "openapi_extra": { + "model": "YfRevenueEstimates" + } + }, + "/yfinance/estimates/eps_trend": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the trend of EPS estimates over time for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.estimates.eps_trend(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEpsTrend", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The estimate period (0q, +1q, 0y, +1y).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "current", + "type": "float | None", + "description": "The current EPS estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_ago_7", + "type": "float | None", + "description": "The EPS estimate 7 days ago.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_ago_30", + "type": "float | None", + "description": "The EPS estimate 30 days ago.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_ago_60", + "type": "float | None", + "description": "The EPS estimate 60 days ago.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "days_ago_90", + "type": "float | None", + "description": "The EPS estimate 90 days ago.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the estimates.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEpsTrend", + "openapi_extra": { + "model": "YfEpsTrend" + } + }, + "/yfinance/estimates/eps_revisions": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the number of upward and downward EPS estimate revisions.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.estimates.eps_revisions(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEpsRevisions", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The estimate period (e.g. 0q, +1q, 0y, +1y).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "up_last_7_days", + "type": "int | None", + "description": "Number of upward revisions over the last 7 days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "up_last_30_days", + "type": "int | None", + "description": "Number of upward revisions over the last 30 days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "down_last_7_days", + "type": "int | None", + "description": "Number of downward revisions over the last 7 days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "down_last_30_days", + "type": "int | None", + "description": "Number of downward revisions over the last 30 days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the estimates.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEpsRevisions", + "openapi_extra": { + "model": "YfEpsRevisions" + } + }, + "/yfinance/estimates/growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the growth estimates for a company versus its index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.estimates.growth(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfGrowthEstimates", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str", + "description": "The estimate period (e.g. 0q, +1q, 0y, +1y, LTG).", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "stock_trend", + "type": "float | None", + "description": "The growth estimate trend for the stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "index_trend", + "type": "float | None", + "description": "The growth estimate trend for the index.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfGrowthEstimates", + "openapi_extra": { + "model": "YfGrowthEstimates" + } + }, + "/yfinance/ownership/institutional": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top institutional holders of a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.ownership.institutional(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfInstitutionalHolders", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date_reported", + "type": "date | None", + "description": "The date the position was reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "holder", + "type": "str | None", + "description": "The name of the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_held", + "type": "float | None", + "description": "The percent of shares outstanding held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "shares", + "type": "int | None", + "description": "The number of shares held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The value of the shares held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_change", + "type": "float | None", + "description": "The change in the percent of shares held since the prior period.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "YfInstitutionalHolders", + "openapi_extra": { + "model": "YfInstitutionalHolders" + } + }, + "/yfinance/ownership/mutual_fund": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top mutual-fund holders of a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.ownership.mutual_fund(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfMutualFundHolders", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date_reported", + "type": "date | None", + "description": "The date of the holdings report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "holder", + "type": "str | None", + "description": "The name of the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_held", + "type": "float | None", + "description": "The percent of shares outstanding held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "shares", + "type": "int | None", + "description": "The number of shares held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "value", + "type": "float | None", + "description": "The value of the shares held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "percent_change", + "type": "float | None", + "description": "The change in percent of shares held by the holder.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "YfMutualFundHolders", + "openapi_extra": { + "model": "YfMutualFundHolders" + } + }, + "/yfinance/ownership/major": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the major-holders breakdown for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.ownership.major(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfMajorHolders", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "insiders_percent_held", + "type": "float | None", + "description": "The percent of shares held by insiders.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "institutions_percent_held", + "type": "float | None", + "description": "The percent of shares held by institutions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "institutions_float_percent_held", + "type": "float | None", + "description": "The percent of float held by institutions.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "institutions_count", + "type": "int | None", + "description": "The number of institutions holding shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfMajorHolders", + "openapi_extra": { + "model": "YfMajorHolders" + } + }, + "/yfinance/ownership/insider_purchases": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the six-month insider-purchase summary for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.ownership.insider_purchases(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfInsiderPurchases", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str", + "description": "The insider purchases category.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "shares", + "type": "float | None", + "description": "The number of shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transactions", + "type": "float | None", + "description": "The number of transactions.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfInsiderPurchases", + "openapi_extra": { + "model": "YfInsiderPurchases" + } + }, + "/yfinance/ownership/insider_roster": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the insider roster (current insider holders) for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.ownership.insider_roster(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "The ticker symbol. Multiple items allowed.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": true, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfInsiderRoster", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "position", + "type": "str | None", + "description": "The position of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "url", + "type": "str | None", + "description": "The URL of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "most_recent_transaction", + "type": "str | None", + "description": "The most recent transaction of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_transaction_date", + "type": "date | None", + "description": "The latest transaction date of the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_owned_directly", + "type": "float | None", + "description": "The number of shares owned directly by the insider.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "position_direct_date", + "type": "date | None", + "description": "The date of the direct position.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfInsiderRoster", + "openapi_extra": { + "model": "YfInsiderRoster" + } + }, + "/yfinance/sectors/overview": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an overview of a market sector.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.sectors.overview(sector='technology', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key. Leave as 'Market (All Sectors)' for the market-level breakdown across every sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfSectorOverview", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str", + "description": "The Yahoo sector key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The symbol of the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The market cap of the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_weight", + "type": "float | None", + "description": "The market weight of the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "companies_count", + "type": "int | None", + "description": "The number of companies in the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industries_count", + "type": "int | None", + "description": "The number of industries in the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employee_count", + "type": "int | None", + "description": "The number of employees in the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "The description of the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfSectorOverview", + "openapi_extra": { + "model": "YfSectorOverview" + } + }, + "/yfinance/sectors/top_companies": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top companies in a market sector.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.sectors.top_companies(sector='technology', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key. Leave as 'Market (All Sectors)' for the top companies across every sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfSectorTopCompanies", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str", + "description": "The Yahoo sector key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the company.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rating", + "type": "str | None", + "description": "The analyst rating for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_weight", + "type": "float | None", + "description": "The market weight of the company within the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfSectorTopCompanies", + "openapi_extra": { + "model": "YfSectorTopCompanies" + } + }, + "/yfinance/sectors/top_funds": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top ETFs or mutual funds in a market sector.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.sectors.top_funds(sector='technology', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key. Leave as 'Market (All Sectors)' for the top funds across every sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "" + } + } + }, + { + "name": "fund_type", + "type": "str | None", + "description": "Whether to return top ETFs or top mutual funds.", + "default": "etf", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "ETF", + "value": "etf" + }, + { + "label": "Mutual Fund", + "value": "mutualfund" + } + ], + "value": "etf" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfSectorTopFunds", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str", + "description": "The Yahoo sector key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fund_type", + "type": "str", + "description": "The type of fund, ETF or mutual fund.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the fund.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfSectorTopFunds", + "openapi_extra": { + "model": "YfSectorTopFunds" + } + }, + "/yfinance/sectors/industries": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the industries within a market sector.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.sectors.industries(sector='technology', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key. Leave as 'Market (All Sectors)' to list the industries across every sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "" + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfSectorIndustries", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str", + "description": "The Yahoo sector key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "key", + "type": "str", + "description": "The Yahoo industry key.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The symbol representing the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_weight", + "type": "float | None", + "description": "The market weight of the industry within the sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfSectorIndustries", + "openapi_extra": { + "model": "YfSectorIndustries" + } + }, + "/yfinance/industry/overview": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get an overview of an industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.industry.overview(industry='software-infrastructure', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key that populates the Industry choices.", + "default": "technology", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "technology" + } + } + }, + { + "name": "industry", + "type": "str | None", + "description": "The Yahoo industry key. Choices cascade from the selected sector; leave empty to load every industry in the sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/yfinance/industry_choices", + "optionsParams": { + "sector": "$sector" + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfIndustryOverview", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "industry", + "type": "str", + "description": "The Yahoo industry key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str | None", + "description": "The symbol representing the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "The sector key the industry belongs to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector_name", + "type": "str | None", + "description": "The name of the sector the industry belongs to.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | None", + "description": "The total market capitalization of the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_weight", + "type": "float | None", + "description": "The market weight of the industry within its sector.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "companies_count", + "type": "int | None", + "description": "The number of companies in the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employee_count", + "type": "int | None", + "description": "The total number of employees in the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "A description of the industry.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfIndustryOverview", + "openapi_extra": { + "model": "YfIndustryOverview" + } + }, + "/yfinance/industry/top_performing": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top-performing companies in an industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.industry.top_performing(industry='software-infrastructure', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key that populates the Industry choices.", + "default": "technology", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "technology" + } + } + }, + { + "name": "industry", + "type": "str | None", + "description": "The Yahoo industry key. Choices cascade from the selected sector; leave empty to load every industry in the sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/yfinance/industry_choices", + "optionsParams": { + "sector": "$sector" + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfIndustryTopPerforming", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "industry", + "type": "str", + "description": "The Yahoo industry key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the company.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ytd_return", + "type": "float | None", + "description": "The year-to-date return of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "The last price of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_price", + "type": "float | None", + "description": "The target price of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfIndustryTopPerforming", + "openapi_extra": { + "model": "YfIndustryTopPerforming" + } + }, + "/yfinance/industry/top_growth": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the top-growth companies in an industry.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.industry.top_growth(industry='software-infrastructure', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "sector", + "type": "str | None", + "description": "The Yahoo sector key that populates the Industry choices.", + "default": "technology", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "options": [ + { + "label": "Market (All Sectors)", + "value": "" + }, + { + "label": "Basic Materials", + "value": "basic-materials" + }, + { + "label": "Communication Services", + "value": "communication-services" + }, + { + "label": "Consumer Cyclical", + "value": "consumer-cyclical" + }, + { + "label": "Consumer Defensive", + "value": "consumer-defensive" + }, + { + "label": "Energy", + "value": "energy" + }, + { + "label": "Financial Services", + "value": "financial-services" + }, + { + "label": "Healthcare", + "value": "healthcare" + }, + { + "label": "Industrials", + "value": "industrials" + }, + { + "label": "Real Estate", + "value": "real-estate" + }, + { + "label": "Technology", + "value": "technology" + }, + { + "label": "Utilities", + "value": "utilities" + } + ], + "value": "technology" + } + } + }, + { + "name": "industry", + "type": "str | None", + "description": "The Yahoo industry key. Choices cascade from the selected sector; leave empty to load every industry in the sector.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "x-widget_config": { + "type": "endpoint", + "optionsEndpoint": "/api/v1/yfinance/industry_choices", + "optionsParams": { + "sector": "$sector" + } + } + } + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfIndustryTopGrowth", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [], + "yfinance": [ + { + "name": "industry", + "type": "str", + "description": "The Yahoo industry key/slug.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol of the company.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ytd_return", + "type": "float | None", + "description": "The year-to-date return of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "growth_estimate", + "type": "float | None", + "description": "The growth estimate of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfIndustryTopGrowth", + "openapi_extra": { + "model": "YfIndustryTopGrowth" + } + }, + "/yfinance/equity/profile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get general information about a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.profile(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEquityInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Common name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cik", + "type": "str | None", + "description": "Central Index Key (CIK) for the requested entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cusip", + "type": "str | None", + "description": "CUSIP identifier for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "isin", + "type": "str | None", + "description": "International Securities Identification Number.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "lei", + "type": "str | None", + "description": "Legal Entity Identifier assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "legal_name", + "type": "str | None", + "description": "Official legal name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "stock_exchange", + "type": "str | None", + "description": "Stock exchange where the company is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sic", + "type": "int | None", + "description": "Standard Industrial Classification code for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_description", + "type": "str | None", + "description": "Short description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "long_description", + "type": "str | None", + "description": "Long description of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ceo", + "type": "str | None", + "description": "Chief Executive Officer of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_url", + "type": "str | None", + "description": "URL of the company's website.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_address", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "mailing_address", + "type": "str | None", + "description": "Mailing address of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "business_phone_no", + "type": "str | None", + "description": "Phone number of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address1", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address2", + "type": "str | None", + "description": "Address of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_city", + "type": "str | None", + "description": "City of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_address_postal_code", + "type": "str | None", + "description": "Zip code of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_state", + "type": "str | None", + "description": "State of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "hq_country", + "type": "str | None", + "description": "Country of the company's headquarters.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_state", + "type": "str | None", + "description": "State in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inc_country", + "type": "str | None", + "description": "Country in which the company is incorporated.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "employees", + "type": "int | None", + "description": "Number of employees working for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_legal_form", + "type": "str | None", + "description": "Legal form of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "entity_status", + "type": "str | None", + "description": "Status of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "latest_filing_date", + "type": "date | None", + "description": "Date of the company's latest filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "irs_number", + "type": "str | None", + "description": "IRS number assigned to the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Sector in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_category", + "type": "str | None", + "description": "Category of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "industry_group", + "type": "str | None", + "description": "Group of industry in which the company operates.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "template", + "type": "str | None", + "description": "Template used to standardize the company's financial statements.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "standardized_active", + "type": "bool | None", + "description": "Whether the company is active or not.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_fundamental_date", + "type": "date | None", + "description": "Date of the company's first fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_fundamental_date", + "type": "date | None", + "description": "Date of the company's last fundamental.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "first_stock_price_date", + "type": "date | None", + "description": "Date of the company's first stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_stock_price_date", + "type": "date | None", + "description": "Date of the company's last stock price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "exchange_timezone", + "type": "str | None", + "description": "The timezone of the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "issue_type", + "type": "str | None", + "description": "The issuance type of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency in which the asset is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "int | None", + "description": "The market capitalization of the asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_outstanding", + "type": "int | None", + "description": "The number of listed shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_float", + "type": "int | None", + "description": "The number of shares in the public float.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_implied_outstanding", + "type": "int | None", + "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares_short", + "type": "int | None", + "description": "The reported number of shares short.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "The dividend yield of the asset, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta", + "type": "float | None", + "description": "The beta of the asset relative to the broad market.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEquityInfo", + "openapi_extra": { + "model": "YfEquityInfo" + } + }, + "/yfinance/equity/screener": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Screen for equities using Yahoo Finance.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.screener(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [ + { + "name": "asset_type", + "type": "str | None", + "description": "Asset type to screen. Selects the Yahoo Finance query universe; 'fund' maps to mutual funds. Sector and industry apply to 'equity'; fund_issuer and fund_style apply to 'etf' and 'fund'.", + "default": "equity", + "optional": true, + "choices": [ + "equity", + "etf", + "fund", + "index", + "future" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "universe", + "type": "bool | None", + "description": "Pull every matching symbol for the given filters, bypassing the market-cap/price/volume floors and the liquidity filter. Use it to enumerate a full region/exchange/sector/industry/fund-issuer/fund-style universe. Requires at least one filter.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fund_issuer", + "type": "str | None", + "description": "Filter funds and ETFs by fund family (issuer), e.g. 'Vanguard'.", + "default": null, + "optional": true, + "choices": [ + "21Shares US LLC", + "3EDGE Asset Management LP", + "3fourteensmi", + "AAM", + "ACV ETFs", + "ADRH", + "AGF Investments Inc.", + "AGF Investments LLC", + "AIA Investment Management Private Ltd", + "ALPHA BLUE CAPITAL", + "ALPS", + "AMG Funds", + "AOT Invest LLC", + "APTUS ETFs", + "AQR Funds", + "ARGA", + "ARK ETF Trust", + "ARLINGTON PARTNERS LLC", + "ARS Investment Partners, LLC", + "ATAC Fund", + "AURA ETFs", + "AXS", + "Abbey Capital", + "Aberdeen Standard Investments", + "Absolute Investment Advisers", + "Academy Asset Management", + "Acadian Funds", + "Accuvest Global Advisors", + "Acquirers Funds", + "Active Passive Funds", + "Acuitas Investments", + "Adaptive ETF", + "Adasina Social Capital", + "Advanced Series Trust", + "Advent Funds", + "AdvisorShares", + "Aegis", + "Affinity Investment Advisors, LLC", + "Akre", + "Alexis Practical Tactical", + "Alfred Berg Kapitalforvaltning AS", + "Alger", + "AllianceBernstein", + "AllianzIM", + "Allspring Global Investments", + "Alpha Architect", + "AlphaBit Investments, LLC", + "AltShares", + "Alternative Access Funds", + "Altrius Capital Management,Inc.", + "Amana", + "American Beacon", + "American Century Investments", + "Amplify ETFs", + "Amplius", + "Amundi Luxembourg S.A.", + "Anfield", + "Angel Oak", + "Anydrus", + "Applied Finance", + "Archer", + "Argent", + "Ariel Investments", + "Arin Risk Advisors LLC", + "Aristotle Funds", + "Armada ETF", + "Armor ETFs", + "Arrow Funds", + "ArrowShares", + "Artisan Partners Funds", + "Aspiriant", + "Astoria Portfolio Advisors LLC", + "Atlas Fund", + "Avantis Investors", + "Ave Maria Mutual Funds", + "Aviva Investors Luxembourg SA", + "Avory Funds", + "Avos Capital Management, LLC", + "Axonic", + "Aztlan ETFs", + "BBH", + "BMO Capital Markets", + "BMO Investments Inc.", + "BNP Paribas Asset Management Luxembourg", + "BNY Mellon", + "BOCHK Asset Management Ltd", + "BOCI-Prudential Asset Management", + "Bahl & Gaynor Inc.", + "Bahl & Gaynor Investment Counsel", + "Baillie Gifford Funds", + "Baird", + "Ballast Asset Management", + "Bancreek Capital Advisors, LLC", + "Bandhan Asset Management Company Limited", + "Bank of Montreal", + "Barclays", + "Baring International Fund Mgrs (Ireland) Limited", + "Bastion ETF", + "Beacon Capital Management Inc", + "Beutel, Goodman & Company Ltd.", + "Beyond Advisors IC", + "Bitwise Investment Advisors, LLC", + "Bitwise Investments", + "BlackRock", + "Blackstone", + "Bluemonte Funds", + "Blueprint Chesapeake", + "BondBloxx Investment Management", + "Bosera Asset Management(Intl) Co., Ltd.", + "Boston Partners", + "Brandes", + "Brendan Wood TopGun Partnerships Inc.", + "Bridge Builder", + "Bridgehouse Asset Managers", + "Bridges", + "Bridgeway", + "Brookmont Capital Management, LLC", + "Brookstone Asset Management", + "Brown Advisory", + "Brown Advisory Funds", + "BufferLABS", + "Build Asset Management, LLC", + "Bushido", + "CF Benchmarks", + "CI Investments Inc", + "CIBC Asset Management Inc", + "CIBC Private Wealth Management", + "COtwo Advisors LLC", + "CSOP Asset Management Pte. Ltd", + "CULTIVAR ETF", + "CYBER HORNET ETFs, LLC", + "Cabana", + "Calamos", + "Calvert ETFs", + "Calvert Research and Management", + "Cambiar Funds", + "Cambria Investment Management", + "Campbell & Company", + "Canoe Financial LP", + "Cantor", + "Capital Group", + "Capital International Asset Mngmt (Canada)", + "Capital-FORCE ETF", + "Carbon Collective Funds", + "Carillon Family of Funds", + "Castellan Group", + "CastleArk Management LLC", + "Catalyst Mutual Funds", + "Catholic Responsible Investments Funds", + "Causeway", + "Champlain Funds", + "China Asset Management (HK) Limited", + "City Different Investments", + "City National Rochdale", + "ClearShares", + "Climate Global ETF", + "Clipper Fund", + "Clockwise Capital LLC", + "Clough Capital Partners L.P.", + "Coastal Funds", + "Cohen & Steers", + "CoinShares ETF Trust", + "Collaborative Fund Advisors, LLC", + "Colterpoint", + "Columbia Threadneedle", + "Column Funds", + "Commerce", + "Community Capital Management", + "Conestoga Capital Advisors", + "Congress", + "Convergence", + "Core Alternative Capital", + "Corgi Funds", + "Coronation Global Fund Managers (Ireland) Limited", + "Counterpoint Funds", + "Counterpoint Mutual Funds", + "CresAlta Investment Management, Inc.", + "CrossingBridge", + "Crossmark Inc", + "Cullen Capital Management, LLC", + "Cullen Funds Trust", + "Curran Investment Partners", + "DEMZ", + "DWS", + "Dana Investment Advisors Inc", + "Davenport", + "Davis ETFs", + "Davis Funds", + "Day Hagan", + "Days Global Advisors", + "Defiance ETFs LLC", + "Destinations Funds", + "Deutsche Bank AG", + "Diamond Hill Funds", + "Dimensional Fund Advisors", + "Direxion Funds", + "Discipline Funds", + "Distillate Capital Partners", + "Dividend Assets Capital, LLC", + "Dodge & Cox", + "Domini", + "Donoghue Forlines LLC", + "DoubleLine", + "DoubleLine ETF Trust", + "Draco Capital Partners", + "Driehaus", + "Dynamic", + "EMQQ", + "Eagle Capital Management, LLC", + "Eaton Vance", + "Eaton Vance ETFs", + "Ecofin", + "Edgewood", + "Eldridge Capital Management", + "Elm Partners Management LLC", + "Emerald", + "Empower Funds", + "EntrepreneurShares", + "Equable Shares", + "Euclidean Technologies Management, LLC", + "Even Herd, LLC", + "Eventide Funds", + "Evoke", + "Exchange Traded Concepts", + "Exponential ETFs", + "F/m Investments LLC", + "FAM", + "FCF Funds", + "FIL Investment Management (HK) Ltd", + "FIL Investment Management (Luxembourg) S.A., Ireland Branch", + "FMI Funds", + "FMQQ", + "FPA", + "Fairholme", + "Fairlead Funds", + "Faith Investor", + "Federated", + "Fidelity Investments", + "First American", + "First Eagle", + "First Manhattan Co.", + "First Trust", + "Flexshares Trust", + "FolioBeyond", + "Formidable Funds", + "Fortuna Funds, LLC", + "Founder ETFs, LLC", + "Franklin Advisers, Inc.", + "Franklin Templeton International Services S.\u00e0 r.l.", + "Franklin Templeton Investments", + "Free Markets ETF", + "Freedom Day Solutions, LLC", + "Freedom Funds", + "Frontier Asset Management, LLC", + "Frost Funds", + "FullerThaler", + "Fullerton Fund Management Company Ltd", + "Fund X", + "Fundsmith Investment Services Limited", + "Fundstrat", + "Future Standard", + "GMO", + "GQG Partners Inc", + "GQG Partners LLC", + "GSR Strategies, LLC", + "Gabelli", + "Gadsden", + "GammaRoad", + "Genter funds", + "Glenmede", + "Global X Funds", + "Golden Eagle Strategies, LLC", + "Goldman Sachs", + "Goose Hollow ETF", + "Gotham", + "Grandeur Peak Funds", + "Graniteshares", + "Grayscale", + "Grizzle ETF", + "Guggenheim Investments", + "GuidePath", + "GuideStone Funds", + "Guinness Atkinson", + "GuruFocusETF", + "HSBC Investment Funds (Luxembourg) S.A.", + "Hamlin Funds", + "Harbor Capital Advisors Inc", + "Harding Loevner", + "Harrison Street", + "Hartford Mutual Funds", + "Hashdex Asset Management Ltd.", + "Hedgeye Asset Management, LLC", + "Helvetia Schweizerische Versicherungsgesellschaft AG", + "Hennessy", + "Hermes Fund Managers Ireland Ltd", + "Hilton Capital Management, LLC", + "Holbrook Holdings", + "Hood River Capital Management", + "Horizon Investments", + "Horizon Kinetics", + "Hotchkis & Wiley", + "Howard Capital Management", + "Hoya Capital Real Estate", + "Hull Tactical Funds", + "Humilis Investment Strategies", + "IA Clarington Investments Inc", + "IDX Advisors, LLC", + "IP Unsure (Only US OE Use)", + "Impact Shares", + "Impax Asset Management", + "Independent Franchise Partners", + "Indexperts", + "InfraCap", + "Innovator ETFs", + "Insight Investment Management (Europe) Limited", + "Inspire", + "Intech", + "Intelligent Funds", + "Intrepid Funds", + "Invesco", + "Investec Investment Management (Pty) Ltd", + "IronHorse", + "Ita\u00fa USA Asset Management, Inc.", + "J.P. Morgan Mansart Management Ltd", + "JLens", + "JOHCM Funds", + "JPMorgan", + "Jackson National", + "Janus Henderson", + "Jensen", + "John Hancock", + "Johnson Mutual Funds", + "KKM Financial LLC", + "Keating Investment Counselors Inc", + "Kensington Asset Management LLC", + "Kingsbarn Capital", + "Kopernik", + "KraneShares", + "Kurv Investment Management Inc.", + "LGIM Managers (Europe) Limited", + "LSV Fund", + "Laffer Tengler Investments, Inc.", + "Langar Funds", + "Lazard", + "Leatherback", + "Leuthold", + "Liberty One Investment Management", + "Life + Liberty Investments, LLC", + "LionShares LLC", + "Little Harbor Advisors", + "LoCorr Funds", + "Logan Capital", + "Lombard Odier Funds (Europe) SA", + "Long Pond Capital, LP", + "Longview Funds", + "Loomis Sayles Funds", + "Lord Abbett", + "Lyrical", + "M.D. Sass ETF", + "MFS", + "MRBL Management, LLC", + "MSA Power Funds LLC", + "MSCM Funds", + "MSIM Fund Management (Ireland) Limited", + "MUFG ETF", + "Mackenzie Investments", + "Madison Asset Management, LLC", + "Madison Funds", + "Main Management ETFs", + "Mairs & Power", + "Man Group PLC", + "Mango Growth ETF", + "Manning & Napier", + "Manulife Investments", + "Manzil", + "MarketDesk", + "Marshfield", + "Mason Capital Partners", + "MassMutual", + "Matrix Asset Advisors Inc", + "Matson Money", + "Matthews Asia Funds", + "McCarthy & Cox Retirement & Estate Specialists, LLC", + "Measured Risk Portfolios, Inc.", + "Meeder Funds", + "Mercer Funds", + "Mercer Global Investments Management Ltd", + "Merk Funds", + "Militia Investments, LLC", + "Miller Value Funds", + "Milliman", + "Mohrfunds", + "Monarch Funds", + "Moonvest ETF", + "Morgan Dempsey", + "Morgan Stanley", + "Morningstar", + "Motley Fool", + "Mutual of America", + "NEXPOINT FUNDS I", + "NPF Investment Advisors", + "National Bank Investments Inc.", + "National security index", + "Nationwide", + "Natixis Funds", + "Navigator Funds", + "Ned Davis Research", + "Nedgroup Investments (IOM) Ltd", + "Needham", + "Neos Funds", + "NestYield", + "Neuberger Berman", + "New York Life Investment Management LLC", + "NextGen EMP, Inc.", + "Nicholas", + "Nicholas Wealth Management", + "Nicholas Wealth, LLC", + "Nightview", + "Ninety One Luxembourg S.A.", + "Nippon Life India Asset Management Ltd", + "Nomura", + "Nordea Investment Funds SA", + "North Square", + "Northern Funds", + "Northern Trust", + "Northern Trust Fund Managers (Ireland) Limited", + "Northern Trust Global Investments Ltd", + "Nuveen", + "OTG Asset Management, Ltd", + "Oakmark", + "Oberweis", + "Obra Fund Management, LLC", + "Ocean Park Asset Management ETF", + "Ocean Park Asset Management, LLC", + "Old Mutual Investment Group (Pty) Limited", + "Old Westbury", + "OneAscent Investment ETF", + "Optimize Financial Inc", + "Orbis Investment Management (Luxembourg) S.A.", + "Osprey Fund LLC", + "Osterweis", + "Overlay Shares", + "PGIM", + "PIMCO", + "PLUS ETF", + "PMV CAPITAL", + "PRIMECAP Odyssey Funds", + "Pabrai Wagons Fund", + "Pacer", + "Pacific Capital Partners Limited", + "Palmer Square Capital Management", + "Paralel Advisors LLC", + "Parametric SAS", + "Parnassus", + "Pathfinder ETFs", + "Patient Capital Management", + "Paydenfunds", + "PeakShares LLC", + "Pear Tree Funds", + "Peerless ETFs", + "Performance Trust Asset Management", + "Permanent Portfolio Family of Funds", + "Pictet Asset Management (Europe) SA", + "Pictet Asset Management Ltd", + "Picton Mahoney Asset Management", + "Pinnacle", + "Point Bridge Capital", + "Polen Capital", + "Portfolio Building Block ETFs", + "Potomac Fund Management Inc.", + "Praxis Investment Management, Inc.", + "Precidian Funds LLC", + "Principal Funds", + "ProFunds", + "ProShares", + "Procure ETF Trust II", + "Prospera Funds Inc.", + "Purpose Investments Inc.", + "Putnam", + "Pzena", + "Pzena Investment Management, LLC", + "Q3 Asset Management Corporation", + "QRAFT Technologies, Inc", + "Quantify Funds", + "RAFI Indices LLC", + "RBC Global Asset Management Inc.", + "RP Investment Advisors LP", + "Rainwater Equity, LLC", + "Rareview Capital", + "Rational Funds", + "Rayliant", + "Raymond James", + "Reckoner Capital Management LLC", + "Redwood Investment Management, LLC", + "Regan Capital", + "Regents Park Funds", + "Relative Sentiment", + "Renaissance Capital", + "Research Affiliates LLC", + "Return stacked ETFs", + "Rex", + "Rita ETF", + "Ritholtz ETFs", + "River Canyon", + "River1 Asset Management LLC", + "RiverNorth Funds", + "Robo Global", + "Rockefeller Global Investment Management", + "Roundhill Financial", + "Roundhill Investments", + "Royce Investment Partners", + "Rrecurrent Advisors", + "Ruk Funds", + "Running Oak Capital LLC", + "Russell", + "Russell Investment Management Limited", + "Rydex Funds", + "SABA ETF", + "SEB Funds AB", + "SEI", + "SEI Investments Co", + "SLGI Asset Management Inc", + "SP Funds", + "SPAC", + "SRN Advisors", + "STFM", + "STONE RIDGE", + "SWP Investment Management, LLC", + "SanJac", + "Sapient Capital LLC", + "Sarmaya Partners, LLC", + "Scharf Investments", + "Schwab ETFs", + "Schwab Funds", + "Scotia Global Asset Management", + "Seafarer Funds", + "Segall Bryant & Hamill", + "Select Funds", + "Selected Funds", + "Sequoia", + "Shelton Capital Management", + "Shenkman Funds", + "Simplify Asset Management", + "Six Circles", + "SmartWay ETFs", + "Smead Funds", + "SoFi", + "SonicShares", + "Sophus Capital", + "Sound ETF", + "Soundwatch Capital", + "Sovereign's Capital, LLC", + "Sparkline Capital", + "Spear", + "Spinnaker ETF Trust", + "Split Rock Private Trading & Wealth Management, LLC", + "Sprott", + "Stance Funds", + "State Farm", + "State Street Investment Management", + "Sterling Capital Funds", + "Stocksnips", + "Strategas Asset Management, LLC", + "Strategy Shares", + "Strive AM", + "Subversive Capital", + "Summit Global Investments", + "SunAmerica", + "Suncoast Equity Management, LLC", + "Swan", + "Swiss Reinsurance Company Ltd", + "Swisscanto Fondsleitung AG", + "Symmetry Partners", + "Syntax", + "T. Rowe Price", + "TBG ETF", + "TCW", + "TD Asset Management Inc", + "THOR", + "TIAA Investments", + "Tactical Advantage", + "Tamarisk Capital Management LLC", + "TappAlpha", + "Tema ETFs", + "Tema Global Limited", + "Teucrium", + "Texas Capital Funds Trust", + "The Brinsmere Funds", + "The Burney Company", + "The Future Fund", + "The Pacific Financial Group", + "Themes ETF Trust", + "Themes Management Company, LLC", + "Thompson IM", + "Thornburg", + "Thrivent", + "Thrivent Funds", + "Tidal Investments LLC", + "TimesSquare Capital Management, LLC", + "Timothy Plan", + "Toews Corporation", + "Tortoise Capital Advisors, LLC", + "Touchstone", + "Towle", + "Transamerica", + "Tremblant Advisors LP", + "TrueShares", + "Truth Social Funds", + "Tuttle Capital Management, LLC", + "Tweedy, Browne", + "Twin Oak ETF Co", + "U.S. Global Investors", + "UBP Asset Management (Europe) S.A.", + "UBS", + "UBS Asset Management (Europe) S.A.", + "UBS Fund Management (Switzerland) AG", + "USCF Investments", + "Unlimited", + "VALIC", + "VS TRUST", + "Valkyrie Digital Assets LLC", + "Value Line", + "Value Partners Group Ltd", + "Van Eck Associates Corporation", + "VanEck", + "Vanguard", + "Variant", + "Vega Capital Partners LLC", + "Vert Asset Management", + "Victory Capital Management Inc.", + "Vident Financial", + "Virtus", + "VistaShares Advisors LLC", + "Volatility Shares LLC", + "Volatility Shares Trust", + "Voya", + "WBI Investments", + "WCM Investment Management", + "WEBs Investments Inc.", + "WHITEWOLF", + "Wahed Invest", + "Warren Street Wealth Advisors", + "Wasatch", + "WealthTrust Asset Management", + "Wedbush Funds", + "Weitz", + "Westwood", + "William Blair", + "WisdomTree", + "Worth Charting", + "Xsquare Capital", + "Xtrackers", + "YieldMax ETFs", + "Yoke ETF", + "ZEGA Investments LLC", + "Zacks Funds", + "abrdn Funds", + "abrdn Investments Luxembourg S.A.", + "iM Global Partner Fund Management", + "iPath", + "iShares", + "kovitzetf", + "xETFS" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "fund_style", + "type": "str | None", + "description": "Filter funds and ETFs by category (style), e.g. 'Large Growth'.", + "default": null, + "optional": true, + "choices": [ + "Aggressive Allocation", + "Alternative Digital Asset", + "Alternative Equity Focused", + "Alternative Multi - Strategy", + "Asia Bond", + "Asia-Pacific ex-Japan Equity", + "Bank Loan", + "Canadian Dividend & Income Equity", + "Canadian Equity", + "Canadian Equity Balanced", + "Canadian Fixed Income Balanced", + "Canadian Focused Equity", + "Canadian Money Market", + "Canadian Neutral Balanced", + "Canadian Short Term Fixed Income", + "China Equity", + "Commodities - Precious Metals", + "Commodities Broad Basket", + "Commodities Focused", + "Communications", + "Conservative Allocation", + "Consumer Cyclical", + "Consumer Defensive", + "Convertibles", + "Corporate Bond", + "Defined Outcome", + "Derivative Income", + "Digital Assets", + "Diversified Emerging Mkts", + "Emerging Markets Bond", + "Emerging Markets Equity", + "Emerging Markets Fixed Income", + "Emerging-Markets Local-Currency Bond", + "Energy Limited Partnership", + "Equity Digital Assets", + "Equity Energy", + "Equity Hedged", + "Equity Market Neutral", + "Equity Precious Metals", + "Europe Large-Cap Blend Equity", + "Europe Stock", + "Event Driven", + "Financial", + "Floating Rate Loans", + "Focused Region", + "Foreign Large Blend", + "Foreign Large Growth", + "Foreign Large Value", + "Foreign Small/Mid Blend", + "Foreign Small/Mid Growth", + "Foreign Small/Mid Value", + "Global Aggressive Allocation", + "Global Bond", + "Global Bond-USD Hedged", + "Global Conservative Allocation", + "Global Core Plus Fixed Income", + "Global Corporate Fixed Income", + "Global Dividend & Income Equity", + "Global Emerging Markets Equity", + "Global Equity", + "Global Equity Balanced", + "Global Equity Income", + "Global Fixed Income", + "Global Fixed Income Balanced", + "Global Infrastructure Equity", + "Global Large-Cap Blend Equity", + "Global Large-Cap Growth Equity", + "Global Large-Stock Blend", + "Global Large-Stock Growth", + "Global Large-Stock Value", + "Global Moderate Allocation", + "Global Moderately Aggressive Allocation", + "Global Moderately Conservative Allocation", + "Global Neutral Balanced", + "Global Real Estate", + "Global Small/Mid Cap Equity", + "Global Small/Mid Stock", + "Government Mortgage-Backed Bond", + "Greater China Region", + "HKD Bond", + "Health", + "High Yield Bond", + "High Yield Fixed Income", + "High Yield Muni", + "India Equity", + "Industrials", + "Inflation-Protected Bond", + "Infrastructure", + "Intermediate Core Bond", + "Intermediate Core-Plus Bond", + "Intermediate Government", + "International Equity", + "Japan Stock", + "Large Blend", + "Large Growth", + "Large Value", + "Large-Cap", + "Long Government", + "Long-Short Equity", + "Long-Term Bond", + "Macro Trading", + "Mid-Cap", + "Mid-Cap Blend", + "Mid-Cap Growth", + "Mid-Cap Value", + "Miscellaneous - Income and Real Property", + "Miscellaneous Allocation", + "Miscellaneous Fixed Income", + "Miscellaneous Sector", + "Moderate Allocation", + "Moderately Aggressive Allocation", + "Moderately Conservative Allocation", + "Money Market - Other", + "Money Market-Taxable", + "Multi-Asset Overlay", + "Multi-Sector Fixed Income", + "Multisector Bond", + "Multistrategy", + "Muni California Intermediate", + "Muni California Long", + "Muni Massachusetts", + "Muni Minnesota", + "Muni National Interm", + "Muni National Long", + "Muni National Short", + "Muni New Jersey", + "Muni New York Intermediate", + "Muni New York Long", + "Muni Ohio", + "Muni Pennsylvania", + "Muni Single State Interm", + "Muni Single State Long", + "Muni Single State Short", + "Muni Target Maturity", + "NOK Bond - Short Term", + "Natural Resources", + "Nontraditional Bond", + "North American Equity", + "Other", + "Other Bond", + "Other Equity", + "Pacific/Asia ex-Japan Stk", + "Preferred Stock", + "Prime Money Market", + "Real Estate", + "Relative Value Arbitrage", + "Sector Equity", + "Sector Equity Healthcare", + "Securitized Bond - Diversified", + "Securitized Bond - Focused", + "Short Government", + "Short-Term Bond", + "Short-Term Inflation-Protected Bond", + "Singapore Equity", + "Single Currency", + "Small Blend", + "Small Growth", + "Small Value", + "Sweden Equity", + "Systematic Trend", + "Tactical Allocation", + "Tactical Balanced", + "Target Maturity", + "Target-Date 2000-2010", + "Target-Date 2015", + "Target-Date 2020", + "Target-Date 2025", + "Target-Date 2030", + "Target-Date 2035", + "Target-Date 2040", + "Target-Date 2045", + "Target-Date 2050", + "Target-Date 2055", + "Target-Date 2060", + "Target-Date 2065", + "Target-Date 2070+", + "Target-Date Retirement", + "Technology", + "Trading--Inverse Commodities", + "Trading--Inverse Debt", + "Trading--Inverse Equity", + "Trading--Leveraged Commodities", + "Trading--Leveraged Debt", + "Trading--Leveraged Equity", + "Trading--Miscellaneous", + "U.S. Dividend & Income Equity", + "US Equity", + "US Large-Cap Blend Equity", + "US Large-Cap Growth Equity", + "US Money Market", + "US Small/Mid Cap Equity", + "USD Aggressive Allocation", + "USD Cautious Allocation", + "USD Diversified Bond", + "USD Flexible Allocation", + "USD Moderate Allocation", + "USD Money Market", + "USD Money Market - Short Term", + "Ultrashort Bond", + "Utilities" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "preset", + "type": "str | None", + "description": "Screener preset to run \u2014 either a Yahoo Finance predefined screener (e.g. 'most_actives', 'day_gainers', 'undervalued_large_caps') or the name of a screener preset INI file. The user presets directory is the 'OPENBB_YFINANCE_PRESETS_DIRECTORY' environment variable, or 'yfinance_presets_directory' / '[yfinance] presets_directory' in openbb.toml, defaulting to '/presets/yfinance/'. Bundled presets are copied there on first use and any user preset of the same name takes precedence. When set, the preset defines the full query and the other filter parameters are ignored.", + "default": null, + "optional": true, + "choices": [ + "losers", + "growth_tech", + "large_cap_value", + "technology_growth", + "undervalued_growth", + "aggressive_small_cap", + "gainers", + "top_etfs", + "undervalued_large_cap", + "most_active", + "aggressive_small_caps", + "day_gainers", + "day_losers", + "growth_technology_stocks", + "most_actives", + "most_shorted_stocks", + "small_cap_gainers", + "undervalued_growth_stocks", + "undervalued_large_caps", + "conservative_foreign_funds", + "high_yield_bond", + "portfolio_anchors", + "solid_large_growth_funds", + "solid_midcap_growth_funds", + "top_mutual_funds", + "top_etfs_us" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "config", + "type": "str | None", + "description": "A JSON screener configuration built by the screener-builder widget: {type, limit, sort_field, sort_type, filters:[{field, operator, value}]}. When set, it defines the full query and the other filter parameters are ignored.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Filter by country. Accepts ISO 3166-1 alpha-2 codes (e.g., 'US', 'DE'), alpha-3 codes (e.g., 'USA'), country names (e.g., 'United States'), or 'all' for all countries.", + "default": "us", + "optional": true, + "choices": [ + "all", + "ar", + "at", + "au", + "be", + "br", + "ca", + "ch", + "cl", + "cn", + "cz", + "de", + "dk", + "ee", + "eg", + "es", + "fi", + "fr", + "gb", + "gr", + "hk", + "hu", + "id", + "ie", + "il", + "in", + "is", + "it", + "jp", + "kr", + "kw", + "lk", + "lt", + "lv", + "mx", + "my", + "nl", + "no", + "nz", + "pe", + "ph", + "pk", + "pl", + "pt", + "qa", + "ro", + "ru", + "sa", + "se", + "sg", + "sr", + "th", + "tr", + "tw", + "us", + "ve", + "vn", + "za" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Filter by exchange.", + "default": null, + "optional": true, + "choices": [ + "ams", + "aqs", + "ase", + "asx", + "ath", + "ber", + "bru", + "bse", + "bts", + "bud", + "bue", + "bvb", + "bvc", + "ccs", + "cnq", + "cph", + "cxe", + "dfm", + "doh", + "dus", + "ebs", + "fka", + "fra", + "ger", + "ham", + "han", + "hel", + "hkg", + "ice", + "iob", + "ise", + "ist", + "jkt", + "jnb", + "jpx", + "kls", + "kuw", + "lis", + "lit", + "lse", + "mce", + "mex", + "mil", + "mun", + "ncm", + "neo", + "ngm", + "nms", + "nsi", + "nyq", + "nze", + "oem", + "oqb", + "oqx", + "osl", + "par", + "pnk", + "pra", + "ris", + "sau", + "ses", + "set", + "sgo", + "shh", + "shz", + "sto", + "stu", + "tai", + "tal", + "tlv", + "tor", + "two", + "van", + "vie", + "vse", + "wse" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "sector", + "type": "str | None", + "description": "Filter by sector.", + "default": null, + "optional": true, + "choices": [ + "basic_materials", + "communication_services", + "consumer_cyclical", + "consumer_defensive", + "energy", + "financial_services", + "healthcare", + "industrials", + "real_estate", + "technology", + "utilities" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "industry", + "type": "str | None", + "description": "Filter by industry.", + "default": null, + "optional": true, + "choices": [ + "advertising_agencies", + "aerospace_defense", + "agricultural_inputs", + "airlines", + "airports_air_services", + "aluminum", + "apparel_manufacturing", + "apparel_retail", + "asset_management", + "auto_components", + "auto_manufacturers", + "auto_parts", + "auto_truck_dealerships", + "automobiles", + "banks", + "biotechnology", + "broadcasting", + "building_materials", + "building_products", + "building_products_equipment", + "business_equipment_supplies", + "capital_markets", + "chemicals", + "coking_coal", + "commercial_services", + "communication_equipment", + "computer_hardware", + "confectioners", + "construction_engineering", + "construction_materials", + "consulting_services", + "consumer_durables", + "consumer_electronics", + "consumer_services", + "copper", + "credit_services", + "department_stores", + "diagnostics_research", + "discount_stores", + "diversified_financials", + "education_training_services", + "electrical_equipment", + "electrical_equipment_parts", + "electronic_components", + "electronic_gaming_multimedia", + "electronics_computer_distribution", + "energy_services", + "engineering_construction", + "entertainment", + "farm_heavy_construction_machinery", + "farm_products", + "financial_conglomerates", + "financial_data_stock_exchanges", + "food_distribution", + "footwear_accessories", + "furnishings_fixtures_appliances", + "gambling", + "gold", + "grocery_stores", + "health_information_services", + "healthcare_plans", + "home_builders", + "home_improvement_retail", + "household_products", + "household_personal_products", + "industrial_conglomerates", + "industrial_distribution", + "information_technology_services", + "infrastructure_operations", + "insurance", + "integrated_freight_logistics", + "internet_content_information", + "internet_retail", + "leisure", + "lodging", + "lumber_wood_production", + "luxury_goods", + "machinery", + "marine_shipping", + "media", + "medical_care_facilities", + "medical_devices", + "medical_distribution", + "medical_instruments_supplies", + "metal_fabrication", + "mortgage_finance", + "oil_gas_drilling", + "oil_gas_e_p", + "oil_gas_equipment_services", + "oil_gas_integrated", + "oil_gas_midstream", + "oil_gas_producers", + "oil_gas_refining_marketing", + "other_industrial_metals_mining", + "other_precious_metals_mining", + "packaged_foods", + "packaging_containers", + "paper_forestry", + "paper_paper_products", + "personal_services", + "pharmaceuticals", + "pharmaceutical_retailers", + "pollution_treatment_controls", + "precious_metals", + "publishing", + "railroads", + "real_estate", + "recreational_vehicles", + "refiners_pipelines", + "rental_leasing_services", + "residential_construction", + "resorts_casinos", + "restaurants", + "retailing", + "scientific_technical_instruments", + "security_protection_services", + "semiconductor_equipment_materials", + "semiconductors", + "shell_companies", + "silver", + "software_and_services", + "solar", + "specialty_business_services", + "specialty_chemicals", + "specialty_industrial_machinery", + "specialty_retail", + "staffing_employment_services", + "steel", + "technology_hardware", + "telecom_services", + "textiles_apparel", + "textile_manufacturing", + "thermal_coal", + "tobacco", + "tools_accessories", + "traders_distributors", + "transportation", + "transportation_infrastructure", + "travel_services", + "trucking", + "uranium", + "utilities", + "waste_management" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "mktcap_min", + "type": "int | None", + "description": "Filter by market cap greater than this value. Default is 500M.", + "default": 500000000, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "mktcap_max", + "type": "int | None", + "description": "Filter by market cap less than this value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "price_min", + "type": "float | None", + "description": "Filter by price greater than this value. Default is, 5", + "default": 5, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "price_max", + "type": "float | None", + "description": "Filter by price less than this value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_min", + "type": "int | None", + "description": "Filter by volume greater than this value. Default is, 10K", + "default": 10000, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "volume_max", + "type": "int | None", + "description": "Filter by volume less than this value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "beta_min", + "type": "float | None", + "description": "Filter by a beta greater than this value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "beta_max", + "type": "float | None", + "description": "Filter by a beta less than this value.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "Limit the number of results returned. Default is, 200. Set to, 0, for all results.", + "default": 200, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEquityScreener", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float", + "description": "Last price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "change", + "type": "float", + "description": "Change in price.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "percent_change", + "type": "float", + "description": "Percent change.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "The ticker symbol.", + "default": null, + "optional": false, + "json_schema_extra": { + "x-widget_config": { + "renderFn": "cellOnClick", + "renderFnParams": { + "actionType": "groupBy", + "groupBy": { + "paramName": "symbol", + "valueField": "symbol" + } + } + } + } + }, + { + "name": "open", + "type": "float | None", + "description": "Open price for the day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "high", + "type": "float | None", + "description": "High price for the day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "low", + "type": "float | None", + "description": "Low price for the day.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "previous_close", + "type": "float | None", + "description": "Previous close price.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ma50", + "type": "float | None", + "description": "50-day moving average.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "ma200", + "type": "float | None", + "description": "200-day moving average.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "52-week high.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "year_low", + "type": "float | None", + "description": "52-week low.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "market_cap", + "type": "float | None", + "description": "Market Cap.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "shares_outstanding", + "type": "float | None", + "description": "Shares outstanding.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "book_value", + "type": "float | None", + "description": "Book value per share.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "price_to_book", + "type": "float | None", + "description": "Price to book ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_ttm", + "type": "float | None", + "description": "Earnings per share over the trailing twelve months.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "eps_forward", + "type": "float | None", + "description": "Forward earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + }, + { + "name": "pe_forward", + "type": "float | None", + "description": "Forward price-to-earnings ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "Trailing twelve month dividend yield.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "frontend_multiply": 100 + } + }, + { + "name": "exchange", + "type": "str | None", + "description": "Exchange where the stock is listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_timezone", + "type": "str | None", + "description": "Timezone of the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_date", + "type": "datetime | None", + "description": "Most recent earnings date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the price data.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEquityScreener", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "YfEquityScreener" + } + }, + "/yfinance/equity/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for an equity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.price.historical(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "2m", + "5m", + "15m", + "30m", + "60m", + "90m", + "1h", + "1d", + "5d", + "1W", + "1M", + "1Q" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "extended_hours", + "type": "bool | None", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_actions", + "type": "bool | None", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEquityHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float | None", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend", + "type": "float | None", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEquityHistorical", + "openapi_extra": { + "model": "YfEquityHistorical" + } + }, + "/yfinance/equity/price/quote": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the latest quote for an equity.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.price.quote(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEquityQuote", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "asset_type", + "type": "str | None", + "description": "Type of asset - i.e, stock, ETF, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the company or asset.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The name or symbol of the venue where the data is from.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "Price of the top bid order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_exchange", + "type": "str | None", + "description": "The specific trading venue where the purchase order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "Price of the top ask order.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_size", + "type": "int | None", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_exchange", + "type": "str | None", + "description": "The specific trading venue where the sale order was placed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the quote.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quote_indicators", + "type": "int | list[int] | list[str] | str | None", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sales_conditions", + "type": "int | list[int] | list[str] | str | None", + "description": "Conditions or condition codes applicable to the sale.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sequence_number", + "type": "int | None", + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_center", + "type": "str | None", + "description": "The ID of the UTP participant that originated the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "participant_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the quote was generated by the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trf_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "sip_timestamp", + "type": "datetime | None", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_price", + "type": "float | None", + "description": "Price of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_tick", + "type": "str | None", + "description": "Whether the last sale was an up or down tick.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_size", + "type": "int | None", + "description": "Size of the last trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "last_timestamp", + "type": "datetime | None", + "description": "Date and Time when the last price was recorded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_volume", + "type": "float | int | None", + "description": "Volume of shares exchanged during the trading day on the specific exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change", + "type": "float | None", + "description": "Change in price from previous close.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "change_percent", + "type": "float | None", + "description": "Change in price as a normalized percentage.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "The one year high (52W High).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The one year low (52W Low).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "ma_50d", + "type": "float | None", + "description": "50-day moving average price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ma_200d", + "type": "float | None", + "description": "200-day moving average price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_average", + "type": "float | None", + "description": "Average daily trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_average_10d", + "type": "float | None", + "description": "Average daily trading volume in the last 10 days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEquityQuote", + "openapi_extra": { + "model": "YfEquityQuote" + } + }, + "/yfinance/equity/fundamental/balance": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the balance sheet for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.balance(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfBalanceSheet", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfBalanceSheet", + "openapi_extra": { + "model": "YfBalanceSheet" + } + }, + "/yfinance/equity/fundamental/cash": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the cash flow statement for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.cash(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCashFlowStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfCashFlowStatement", + "openapi_extra": { + "model": "YfCashFlowStatement" + } + }, + "/yfinance/equity/fundamental/income": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the income statement for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.income(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": null, + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 5, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "period", + "type": "str | None", + "description": "Time period of the data to return.", + "default": "annual", + "optional": true, + "choices": [ + "annual", + "quarter" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfIncomeStatement", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "period_ending", + "type": "date", + "description": "The end date of the reporting period.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "The fiscal period of the report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "The fiscal year of the fiscal period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfIncomeStatement", + "openapi_extra": { + "model": "YfIncomeStatement" + } + }, + "/yfinance/equity/fundamental/dividends": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical dividend data for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.dividends(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfHistoricalDividends", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ex_dividend_date", + "type": "date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "amount", + "type": "float", + "description": "The dividend amount per share.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfHistoricalDividends", + "openapi_extra": { + "model": "YfHistoricalDividends" + } + }, + "/yfinance/equity/fundamental/metrics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get fundamental metrics for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.metrics(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfKeyMetrics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "period_ending", + "type": "date | None", + "description": "End date of the reporting period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "Fiscal year for the fiscal period, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_period", + "type": "str | None", + "description": "Fiscal period for the data, if available.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency in which the data is reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "market_cap", + "type": "float | int | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "currency", + "type": "str | None", + "description": "Currency in which the data is presented.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "pe_ratio", + "type": "float | None", + "description": "Price-to-earnings ratio (TTM).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "forward_pe", + "type": "float | None", + "description": "Forward price-to-earnings ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "peg_ratio", + "type": "float | None", + "description": "PEG ratio (5-year expected).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "peg_ratio_ttm", + "type": "float | None", + "description": "PEG ratio (TTM).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_ttm", + "type": "float | None", + "description": "Earnings per share (TTM).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_forward", + "type": "float | None", + "description": "Forward earnings per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "enterprise_to_ebitda", + "type": "float | None", + "description": "Enterprise value to EBITDA ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "earnings_growth", + "type": "float | None", + "description": "Earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "earnings_growth_quarterly", + "type": "float | None", + "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "revenue_per_share", + "type": "float | None", + "description": "Revenue per share (TTM).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revenue_growth", + "type": "float | None", + "description": "Revenue growth (Year Over Year), as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "enterprise_to_revenue", + "type": "float | None", + "description": "Enterprise value to revenue ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "cash_per_share", + "type": "float | None", + "description": "Cash per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "quick_ratio", + "type": "float | None", + "description": "Quick ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_ratio", + "type": "float | None", + "description": "Current ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "debt_to_equity", + "type": "float | None", + "description": "Debt-to-equity ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gross_margin", + "type": "float | None", + "description": "Gross margin, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "operating_margin", + "type": "float | None", + "description": "Operating margin, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "ebitda_margin", + "type": "float | None", + "description": "EBITDA margin, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "profit_margin", + "type": "float | None", + "description": "Profit margin, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_on_assets", + "type": "float | None", + "description": "Return on assets, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_on_equity", + "type": "float | None", + "description": "Return on equity, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "Dividend yield, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "dividend_yield_5y_avg", + "type": "float | None", + "description": "5-year average dividend yield, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "payout_ratio", + "type": "float | None", + "description": "Payout ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "book_value", + "type": "float | None", + "description": "Book value per share.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to_book", + "type": "float | None", + "description": "Price-to-book ratio.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "enterprise_value", + "type": "int | None", + "description": "Enterprise value.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "overall_risk", + "type": "float | None", + "description": "Overall risk score.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "audit_risk", + "type": "float | None", + "description": "Audit risk score.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "board_risk", + "type": "float | None", + "description": "Board risk score.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "compensation_risk", + "type": "float | None", + "description": "Compensation risk score.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shareholder_rights_risk", + "type": "float | None", + "description": "Shareholder rights risk score.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "beta", + "type": "float | None", + "description": "Beta relative to the broad market (5-year monthly).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_return_1y", + "type": "float | None", + "description": "One-year price return, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + } + ] + }, + "model": "YfKeyMetrics", + "openapi_extra": { + "model": "YfKeyMetrics" + } + }, + "/yfinance/equity/fundamental/management": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get key executives for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.management(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfKeyExecutives", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "title", + "type": "str", + "description": "Designation of the key executive.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Name of the key executive.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "pay", + "type": "int | None", + "description": "Pay of the key executive.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency_pay", + "type": "str | None", + "description": "Currency of the pay.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "gender", + "type": "str | None", + "description": "Gender of the key executive.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_born", + "type": "int | None", + "description": "Birth year of the key executive.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "exercised_value", + "type": "int | None", + "description": "Value of shares exercised.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unexercised_value", + "type": "int | None", + "description": "Value of shares not exercised.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fiscal_year", + "type": "int | None", + "description": "Fiscal year of the pay.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfKeyExecutives", + "openapi_extra": { + "model": "YfKeyExecutives" + } + }, + "/yfinance/equity/fundamental/historical_eps": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical earnings-per-share for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.historical_eps(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [ + { + "name": "limit", + "type": "int | None", + "description": "The number of earnings dates to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfHistoricalEps", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "eps_actual", + "type": "float | int | None", + "description": "Actual EPS from the earnings date.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_estimated", + "type": "float | int | None", + "description": "Estimated EPS for the earnings date.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "surprise_percent", + "type": "float | None", + "description": "The earnings surprise, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 1 + } + } + ] + }, + "model": "YfHistoricalEps", + "openapi_extra": { + "model": "YfHistoricalEps" + } + }, + "/yfinance/equity/fundamental/filings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the SEC filings for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.fundamental.filings(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCompanyFilings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "filing_date", + "type": "date", + "description": "The date of the filing.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "report_type", + "type": "str | None", + "description": "Type of filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "title", + "type": "str | None", + "description": "The title of the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfCompanyFilings", + "openapi_extra": { + "model": "YfCompanyFilings" + } + }, + "/yfinance/equity/estimates/consensus": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the analyst price target consensus.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.estimates.consensus(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfPriceTargetConsensus", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The company name", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_high", + "type": "float | None", + "description": "High target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_low", + "type": "float | None", + "description": "Low target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_consensus", + "type": "float | None", + "description": "Consensus target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "target_median", + "type": "float | None", + "description": "Median target of the price target consensus.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "recommendation", + "type": "str | None", + "description": "Recommendation - buy, sell, etc.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "recommendation_mean", + "type": "float | None", + "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "number_of_analysts", + "type": "int | None", + "description": "Number of analysts providing opinions.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "current_price", + "type": "float | None", + "description": "Current price of the stock.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the stock is priced in.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfPriceTargetConsensus", + "openapi_extra": { + "model": "YfPriceTargetConsensus" + } + }, + "/yfinance/equity/estimates/price_target": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the analyst price target upgrades and downgrades.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.estimates.price_target(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None | list[str | None]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfPriceTarget", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "published_date", + "type": "date | datetime", + "description": "Published date of the price target.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "published_time", + "type": "time | None", + "description": "Time of the original rating, UTC.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Exchange where the company is traded.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_name", + "type": "str | None", + "description": "Name of company that is the subject of rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "analyst_name", + "type": "str | None", + "description": "Analyst name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "analyst_firm", + "type": "str | None", + "description": "Name of the analyst firm that published the price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the data is denominated in.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_target", + "type": "float | None", + "description": "The current price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "adj_price_target", + "type": "float | None", + "description": "Adjusted price target for splits and stock dividends.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_target_previous", + "type": "float | None", + "description": "Previous price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous_adj_price_target", + "type": "float | None", + "description": "Previous adjusted price target.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_when_posted", + "type": "float | None", + "description": "Price when posted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rating_current", + "type": "str | None", + "description": "The analyst's rating for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "rating_previous", + "type": "str | None", + "description": "Previous analyst rating for the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "action", + "type": "str | None", + "description": "Description of the change in rating from firm's last rating.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "price_target_action", + "type": "str | None", + "description": "The price target action (e.g. up, down, init).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfPriceTarget", + "openapi_extra": { + "model": "YfPriceTarget" + } + }, + "/yfinance/equity/ownership/share_statistics": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get share statistics for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.ownership.share_statistics(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfShareStatistics", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "free_float", + "type": "float | None", + "description": "Percentage of unrestricted shares of a publicly-traded company.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "float_shares", + "type": "float | int | None", + "description": "Number of shares available for trading by the general public.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "outstanding_shares", + "type": "float | int | None", + "description": "Total number of shares of a publicly-traded company.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "implied_shares_outstanding", + "type": "int | None", + "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_interest", + "type": "int | None", + "description": "Number of shares that are reported short.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_percent_of_float", + "type": "float | None", + "description": "Percentage of shares that are reported short, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "days_to_cover", + "type": "float | None", + "description": "Number of days to repurchase the shares as a ratio of average daily volume", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_interest_prev_month", + "type": "int | None", + "description": "Number of shares that were reported short in the previous month.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "short_interest_prev_date", + "type": "date | None", + "description": "Date of the previous month's report.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "insider_ownership", + "type": "float | None", + "description": "Percentage of shares held by insiders, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "institution_ownership", + "type": "float | None", + "description": "Percentage of shares held by institutions, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "institution_float_ownership", + "type": "float | None", + "description": "Percentage of float held by institutions, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "institutions_count", + "type": "int | None", + "description": "Number of institutions holding shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfShareStatistics", + "openapi_extra": { + "model": "YfShareStatistics" + } + }, + "/yfinance/equity/ownership/insider_trading": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get insider trading transactions for a company.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.ownership.insider_trading(symbol='AAPL', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfInsiderTrading", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "company_cik", + "type": "str | None", + "description": "CIK number of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | datetime | None", + "description": "Filing date of the trade.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_date", + "type": "date | None", + "description": "Date of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_cik", + "type": "int | str | None", + "description": "Reporting individual's CIK.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_name", + "type": "str | None", + "description": "Name of the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "owner_title", + "type": "str | None", + "description": "The title held by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ownership_type", + "type": "str | None", + "description": "Type of ownership, e.g., direct or indirect.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_type", + "type": "str | None", + "description": "Type of transaction being reported.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "acquisition_or_disposition", + "type": "str | None", + "description": "Acquisition or disposition of the shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "security_type", + "type": "str | None", + "description": "The type of security transacted.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_owned", + "type": "float | None", + "description": "Number of securities owned by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "securities_transacted", + "type": "float | None", + "description": "Number of securities transacted by the reporting individual.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "transaction_price", + "type": "float | None", + "description": "The price of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_url", + "type": "str | None", + "description": "Link to the filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "transaction_value", + "type": "float | None", + "description": "Value of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the transaction.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfInsiderTrading", + "openapi_extra": { + "model": "YfInsiderTrading" + } + }, + "/yfinance/equity/calendar/earnings": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the earnings calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.calendar.earnings(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "limit", + "type": "int | None", + "description": "The maximum number of results to return. Yahoo caps at 100.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCalendarEarnings", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "report_date", + "type": "date", + "description": "The date of the earnings report.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "Name of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_previous", + "type": "float | None", + "description": "The earnings-per-share from the same previously reported period.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_consensus", + "type": "float | None", + "description": "The analyst conesus earnings-per-share estimate.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "market_cap", + "type": "float | None", + "description": "Market capitalization of the entity.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "timing", + "type": "str | None", + "description": "The timing of the earnings event (e.g. BMO, AMC).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "eps_surprise_percent", + "type": "float | None", + "description": "The earnings surprise, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 1 + } + } + ] + }, + "model": "YfCalendarEarnings", + "openapi_extra": { + "model": "YfCalendarEarnings" + } + }, + "/yfinance/equity/calendar/ipo": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the IPO calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.calendar.ipo(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol to get data for.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "limit", + "type": "int | None", + "description": "The number of data entries to return.", + "default": 100, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCalendarIpo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ipo_date", + "type": "date | None", + "description": "The date of the IPO, when the stock first trades on a major exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange where the company will be listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "filing_date", + "type": "date | None", + "description": "The date of the IPO filing.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_from", + "type": "float | None", + "description": "The low end of the expected price range.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price_to", + "type": "float | None", + "description": "The high end of the expected price range.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The offer price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency of the offer.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "shares", + "type": "float | None", + "description": "The number of shares.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "action", + "type": "str | None", + "description": "The status of the IPO (e.g. Expected, Priced).", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfCalendarIpo", + "openapi_extra": { + "model": "YfCalendarIpo" + } + }, + "/yfinance/equity/calendar/splits": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the stock splits calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.equity.calendar.splits(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCalendarSplits", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "numerator", + "type": "float", + "description": "Numerator of the stock split.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "denominator", + "type": "float", + "description": "Denominator of the stock split.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str | None", + "description": "The ticker symbol.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "The name of the company.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "optionable", + "type": "bool | None", + "description": "Whether the company has options.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfCalendarSplits", + "openapi_extra": { + "model": "YfCalendarSplits" + } + }, + "/yfinance/etf/info": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get ETF information overview.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.etf.info(symbol='SPY', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEtfInfo", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data. (ETF)", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str", + "description": "Name of the ETF.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "issuer", + "type": "str | None", + "description": "Issuer of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "domicile", + "type": "str | None", + "description": "Domicile of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "website", + "type": "str | None", + "description": "Website of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "description", + "type": "str | None", + "description": "Description of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "inception_date", + "type": "date | None", + "description": "Inception date of the ETF.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "fund_type", + "type": "str | None", + "description": "The legal type of fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "fund_family", + "type": "str | None", + "description": "The fund family.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "The fund category.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "The exchange the fund is listed on.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange_timezone", + "type": "str | None", + "description": "The timezone of the exchange.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "The currency in which the fund is listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "nav_price", + "type": "float | None", + "description": "The net asset value per unit of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "total_assets", + "type": "int | None", + "description": "The total value of assets held by the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "trailing_pe", + "type": "float | None", + "description": "The trailing twelve month P/E ratio of the fund's assets.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield", + "type": "float | None", + "description": "The dividend yield of the fund, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "dividend_rate_ttm", + "type": "float | None", + "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend_yield_ttm", + "type": "float | None", + "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "year_high", + "type": "float | None", + "description": "The fifty-two week high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "year_low", + "type": "float | None", + "description": "The fifty-two week low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ma_50d", + "type": "float | None", + "description": "50-day moving average price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ma_200d", + "type": "float | None", + "description": "200-day moving average price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "return_ytd", + "type": "float | None", + "description": "The year-to-date return of the fund, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_3y_avg", + "type": "float | None", + "description": "The three year average return of the fund, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "return_5y_avg", + "type": "float | None", + "description": "The five year average return of the fund, as a normalized percent.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "percent", + "x-frontend_multiply": 100 + } + }, + { + "name": "beta_3y_avg", + "type": "float | None", + "description": "The three year average beta of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg", + "type": "float | None", + "description": "The average daily trading volume of the fund.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume_avg_10d", + "type": "float | None", + "description": "The average daily trading volume of the fund over the past ten days.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid", + "type": "float | None", + "description": "The current bid price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "bid_size", + "type": "float | None", + "description": "The current bid size.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask", + "type": "float | None", + "description": "The current ask price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "ask_size", + "type": "float | None", + "description": "The current ask size.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price of the most recent trading session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The highest price of the most recent trading session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The lowest price of the most recent trading session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "int | None", + "description": "The trading volume of the most recent trading session.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "prev_close", + "type": "float | None", + "description": "The previous closing price.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEtfInfo", + "openapi_extra": { + "model": "YfEtfInfo" + } + }, + "/yfinance/etf/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for an ETF.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.etf.historical(symbol='SPY', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "extended_hours", + "type": "bool | None", + "description": "Include Pre and Post market data.", + "default": false, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "include_actions", + "type": "bool | None", + "description": "Include dividends and stock splits in results.", + "default": true, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "adjustment", + "type": "str | None", + "description": "The adjustment factor to apply. Default is splits only.", + "default": "splits_only", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEtfHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float", + "description": "The open price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float", + "description": "The high price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float", + "description": "The low price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "split_ratio", + "type": "float | None", + "description": "Ratio of the equity split, if a split occurred.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "dividend", + "type": "float | None", + "description": "Dividend amount (split-adjusted), if a dividend was paid.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEtfHistorical", + "openapi_extra": { + "model": "YfEtfHistorical" + } + }, + "/yfinance/derivatives/options/get_tickers": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve expiry/strike dropdown choices for a symbol (loads it on first call).", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "", + "optional": true + }, + { + "name": "expiry_list", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "strike_list", + "type": "bool", + "description": "", + "default": false, + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/yfinance/derivatives/options/chains": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the options chain table, filtered by expiry, type, and moneyness.\n\nUses the shared per-symbol cache so it never refetches when other views have\nalready loaded the symbol.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "expiry", + "type": "str", + "description": "Filter to the nearest expiry on or after this date.", + "default": null, + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "Calls, puts, or both.", + "default": "both", + "optional": true + }, + { + "name": "otm_only", + "type": "bool", + "description": "Show only out-of-the-money contracts.", + "default": false, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/yfinance/derivatives/options/straddle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long straddle at each expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM.", + "default": null, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/yfinance/derivatives/options/strangle": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price a long strangle at each expiration for a given moneyness.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "", + "default": 5, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/yfinance/derivatives/options/spreads": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price all four vertical spreads at each expiration.\n\nThe two legs sit ``near_moneyness`` and ``far_moneyness`` percent\nout-of-the-money. Swapping which leg is sold flips bull versus bear, so call\nspreads yield bull and bear call spreads and put spreads yield bull and bear\nput spreads; the Strategy column names each.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "spread_type", + "type": "str", + "description": "Vertical call spreads, put spreads, or both.", + "default": "both", + "optional": true + }, + { + "name": "near_moneyness", + "type": "float", + "description": "", + "default": 2.5, + "optional": true + }, + { + "name": "far_moneyness", + "type": "float", + "description": "", + "default": 7.5, + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "model": "" + } + }, + "/yfinance/derivatives/options/smile": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility smile / skew across strikes.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "expirations", + "type": "str", + "description": "Up to five expiration dates (comma-separated).", + "default": null, + "optional": true + }, + { + "name": "otm", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "skew", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Options Smile", + "type": "chart", + "raw": true, + "category": "Equity", + "subCategory": "Options", + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/yfinance/derivatives/options/surface": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Implied-volatility 3-D surface over DTE and strike.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "", + "default": "otm", + "optional": true + }, + { + "name": "dte_min", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "dte_max", + "type": "int", + "description": "", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "", + "default": null, + "optional": true + }, + { + "name": "oi", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "volume", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Options Surface", + "type": "chart", + "raw": true, + "category": "Equity", + "subCategory": "Options", + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/yfinance/derivatives/options/stats": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open-interest or volume statistics by strike or expiration.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "by", + "type": "str", + "description": "", + "default": "expiration", + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Open interest or volume.", + "default": "oi", + "optional": true + }, + { + "name": "date", + "type": "str", + "description": "Expiry to view by strike (switches 'by' to strike).", + "default": null, + "optional": true + }, + { + "name": "unit", + "type": "str", + "description": "", + "default": "value", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Options Stats", + "type": "chart", + "raw": true, + "category": "Equity", + "subCategory": "Options", + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/yfinance/derivatives/options/term_structure": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Price or IV term structure across expirations.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "The underlying ticker symbol.", + "default": "AAPL", + "optional": true + }, + { + "name": "strike", + "type": "float", + "description": "Target strike. Default is nearest OTM per expiry.", + "default": null, + "optional": true + }, + { + "name": "moneyness", + "type": "float", + "description": "", + "default": null, + "optional": true + }, + { + "name": "metric", + "type": "str", + "description": "Implied volatility or price.", + "default": "iv", + "optional": true + }, + { + "name": "option_type", + "type": "str", + "description": "", + "default": "both", + "optional": true + }, + { + "name": "raw", + "type": "bool", + "description": "", + "default": false, + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Options Term Structure", + "type": "chart", + "raw": true, + "category": "Equity", + "subCategory": "Options", + "gridData": { + "w": 40, + "h": 18 + }, + "refetchInterval": false + } + } + }, + "/yfinance/derivatives/futures/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a futures contract.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.derivatives.futures.historical(symbol='ES', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str | None", + "description": "Future expiry date with format YYYY-MM", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFuturesHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfFuturesHistorical", + "openapi_extra": { + "model": "YfFuturesHistorical" + } + }, + "/yfinance/derivatives/futures/curve": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the futures curve for a symbol.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.derivatives.futures.curve(symbol='ES', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol to get data for.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | str | None | list[date | str | None]", + "description": "A specific date to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfFuturesCurve", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "expiration", + "type": "str", + "description": "Futures expiration month.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "price", + "type": "float | None", + "description": "The price of the futures contract.", + "default": null, + "optional": true, + "json_schema_extra": { + "x-unit_measurement": "currency" + } + } + ], + "yfinance": [] + }, + "model": "YfFuturesCurve", + "openapi_extra": { + "model": "YfFuturesCurve" + } + }, + "/yfinance/index/available": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the list of available indices.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.index.available(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfAvailableIndices", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "name", + "type": "str | None", + "description": "", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "exchange", + "type": "str | None", + "description": "Stock exchange where the index is listed.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency the index is traded in.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "symbol", + "type": "str", + "description": "Symbol for the index.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "code", + "type": "str", + "description": "ID code for keying the index in the OpenBB Terminal.", + "default": null, + "optional": false, + "json_schema_extra": {} + } + ] + }, + "model": "YfAvailableIndices", + "openapi_extra": { + "model": "YfAvailableIndices" + } + }, + "/yfinance/index/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for an index.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.index.price.historical(symbol='^GSPC', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "2m", + "5m", + "15m", + "30m", + "60m", + "90m", + "1h", + "1d", + "5d", + "1W", + "1M", + "1Q" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfIndexHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "symbol", + "type": "str | None", + "description": "Symbol representing the entity requested in the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float | None", + "description": "The close price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | int | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfIndexHistorical", + "openapi_extra": { + "model": "YfIndexHistorical" + } + }, + "/yfinance/crypto/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a cryptocurrency pair.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.crypto.price.historical(symbol='BTC-USD', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "2m", + "5m", + "15m", + "30m", + "60m", + "90m", + "1h", + "1d", + "5d", + "1W", + "1M", + "1Q" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCryptoHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfCryptoHistorical", + "openapi_extra": { + "model": "YfCryptoHistorical" + } + }, + "/yfinance/currency/price/historical": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get historical price data for a currency pair.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.currency.price.historical(symbol='EURUSD=X', provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str | list[str]", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): yfinance.", + "default": null, + "optional": false, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": { + "yfinance": { + "multiple_items_allowed": true + } + } + }, + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "interval", + "type": "str | None", + "description": "Time interval of the data to return.", + "default": "1d", + "optional": true, + "choices": [ + "1m", + "2m", + "5m", + "15m", + "30m", + "60m", + "90m", + "1h", + "1d", + "5d", + "1W", + "1M", + "1Q" + ], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfCurrencyHistorical", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "date | datetime | str", + "description": "The date of the data.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "open", + "type": "float | None", + "description": "The open price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "high", + "type": "float | None", + "description": "The high price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "low", + "type": "float | None", + "description": "The low price.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "close", + "type": "float", + "description": "The close price.", + "default": null, + "optional": false, + "json_schema_extra": {} + }, + { + "name": "volume", + "type": "float | None", + "description": "The trading volume.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "vwap", + "type": "float | None", + "description": "Volume Weighted Average Price over the period.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "model": "YfCurrencyHistorical", + "openapi_extra": { + "model": "YfCurrencyHistorical" + } + }, + "/yfinance/economy/calendar": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Get the economic events calendar.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\nobb.yfinance.economy.calendar(provider='yfinance')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "start_date", + "type": "date | None | str", + "description": "Start date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + }, + { + "name": "end_date", + "type": "date | None | str", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": [], + "multiple_items_allowed": false, + "json_schema_extra": {} + } + ], + "yfinance": [] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "YfEconomicCalendar", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str | None", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": { + "standard": [ + { + "name": "date", + "type": "datetime | None | str", + "description": "The date of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "country", + "type": "str | None", + "description": "Country of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "category", + "type": "str | None", + "description": "Category of event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "event", + "type": "str | None", + "description": "Event name.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "importance", + "type": "str | None", + "description": "The importance level for the event.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "source", + "type": "str | None", + "description": "Source of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "currency", + "type": "str | None", + "description": "Currency of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "unit", + "type": "str | None", + "description": "Unit of the data.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "consensus", + "type": "float | str | None", + "description": "Average forecast among a representative group of economists.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "previous", + "type": "float | str | None", + "description": "Value for the previous period after the revision (if revision is applicable).", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "revised", + "type": "float | str | None", + "description": "Revised previous value, if applicable.", + "default": null, + "optional": true, + "json_schema_extra": {} + }, + { + "name": "actual", + "type": "float | str | None", + "description": "Latest released value.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ], + "yfinance": [ + { + "name": "reference_period", + "type": "str | None", + "description": "The reference period the release is for.", + "default": null, + "optional": true, + "json_schema_extra": {} + } + ] + }, + "model": "YfEconomicCalendar", + "openapi_extra": { + "model": "YfEconomicCalendar" + } + }, + "/yfinance/tv_widget": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open an interactive TradingView chart powered by the Yahoo Finance datafeed.\n\nOpens a native desktop window, or renders inline in a Jupyter notebook, and\nreturns immediately without blocking. On a headless host, returns the iframe\nendpoint to embed instead.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Open an interactive TradingView chart in a native window.\nobb.yfinance.tv_widget(symbol='AAPL')\n```\n\n", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AAPL", + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "", + "default": "1d", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/yfinance/screener_builder": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Open the interactive Yahoo Finance screener builder.\n\nOpens a native desktop window, or renders inline in a Jupyter notebook, and\nreturns immediately without blocking. On a headless host (e.g. the REST API),\nreturns the iframe endpoint to embed instead. To run a screen\nprogrammatically, use ``obb.yfinance.equity.screener``.", + "examples": "Examples\n--------\n\n```python\nfrom openbb import obb\n# Open the interactive screener builder in a native window.\nobb.yfinance.screener_builder()\n```\n\n", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": { + "OBBject": [ + { + "name": "results", + "type": "Any", + "description": "Serializable results." + }, + { + "name": "provider", + "type": "str", + "description": "Provider name." + }, + { + "name": "warnings", + "type": "Optional[list[Warning_]]", + "description": "List of warnings." + }, + { + "name": "chart", + "type": "Optional[Chart]", + "description": "Chart object." + }, + { + "name": "extra", + "type": "dict[str, Any]", + "description": "Extra info." + } + ] + }, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "exclude": true + }, + "model": "" + } + }, + "/yfinance/tv_widget/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve PyWry's TradingView widget HTML for the Workspace iframe.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AAPL", + "optional": true + }, + { + "name": "interval", + "type": "str", + "description": "", + "default": "1d", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "TradingView Chart (Yahoo Finance)", + "description": "Interactive TradingView chart powered by Yahoo Finance.", + "type": "iframe", + "category": "Equity", + "subCategory": "Charts", + "widgetId": "yfinance_tv_widget_obb", + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AAPL", + "description": "The ticker symbol to chart." + }, + { + "paramName": "interval", + "label": "Interval", + "value": "1d", + "description": "The chart interval.", + "options": [ + { + "label": "1m", + "value": "1m" + }, + { + "label": "5m", + "value": "5m" + }, + { + "label": "15m", + "value": "15m" + }, + { + "label": "30m", + "value": "30m" + }, + { + "label": "1h", + "value": "1h" + }, + { + "label": "1d", + "value": "1d" + }, + { + "label": "1w", + "value": "1w" + }, + { + "label": "1M", + "value": "1M" + } + ], + "show": false + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 40, + "h": 20 + }, + "refetchInterval": false + } + } + }, + "/yfinance/asset_info/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the styled, live Asset Info overview widget HTML for the Workspace.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "symbol", + "type": "str", + "description": "", + "default": "AAPL", + "optional": true + }, + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Asset Info (Yahoo Finance)", + "description": "Styled overview with a live header price \u2014 summary, key statistics, valuation, analyst coverage, ownership, calendar, holdings and sector weightings \u2014 adapting to the asset type.", + "type": "iframe", + "category": "Equity", + "subCategory": "Profile", + "widgetId": "yfinance_asset_info_obb", + "params": [ + { + "paramName": "symbol", + "label": "Symbol", + "value": "AAPL", + "description": "The ticker symbol." + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 20, + "h": 20 + }, + "refetchInterval": false + } + } + }, + "/yfinance/screener_builder/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the interactive screener-builder iframe page.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Screener Builder", + "description": "Interactively build a screener configuration across a universe of assets. Configurations can be saved and reloaded.", + "type": "iframe", + "category": "Equity", + "subCategory": "Screener", + "widgetId": "yfinance_screener_builder_obb", + "params": [ + { + "paramName": "config", + "label": "Screener Config", + "value": "", + "description": "The screener configuration emitted by the builder.", + "show": false + }, + { + "paramName": "theme", + "show": false + } + ], + "gridData": { + "w": 16, + "h": 18 + }, + "refetchInterval": false, + "source": [ + "yFinance" + ] + } + } + }, + "/yfinance/rrg/view": { + "deprecated": { + "flag": null, + "message": null + }, + "description": "Serve the interactive Relative Rotation Graph iframe.", + "examples": "", + "parameters": { + "standard": [ + { + "name": "theme", + "type": "str", + "description": "", + "default": "dark", + "optional": true + } + ] + }, + "returns": {}, + "data": {}, + "model": "", + "openapi_extra": { + "widget_config": { + "name": "Relative Rotation Graph (Yahoo Finance)", + "description": "Interactive Relative Rotation Graph \u2014 RS-Ratio vs RS-Momentum against a benchmark \u2014 with an in-widget sidebar and the three tables that build it (Study Data, RS-Ratio, RS-Momentum).", + "type": "iframe", + "category": "Equity", + "subCategory": "Technical", + "widgetId": "yfinance_rrg_obb", + "gridData": { + "w": 40, + "h": 24 + }, + "refetchInterval": false, + "source": [ + "yFinance" + ], + "params": [ + { + "paramName": "theme", + "show": false + } + ] + } + } + } + }, + "routers": { + "/bls": { + "description": "BLS Core (Series, Search, Calendar) router." + }, + "/bls/cpi": { + "description": "BLS CPI router." + }, + "/bls/ppi": { + "description": "BLS PPI router." + }, + "/bls/jolts": { + "description": "BLS JOLTS router." + }, + "/bls/employment_situation": { + "description": "BLS Employment Situation (CES) router." + }, + "/bls/productivity": { + "description": "BLS Productivity router." + }, + "/bls/real_earnings": { + "description": "BLS Real Earnings router." + }, + "/bls/import_export": { + "description": "BLS Import/Export Price Index router." + }, + "/cboe": { + "description": "Cboe provider router." + }, + "/cboe/equity": { + "description": "Cboe equity data." + }, + "/cboe/index": { + "description": "Cboe index data." + }, + "/cboe/options": { + "description": "Cboe options data and analysis." + }, + "/cboe/futures": { + "description": "Cboe futures data." + }, + "/cftc": { + "description": "Commitment of Traders reports and DTCC swap transaction data." + }, + "/deribit": { + "description": "Deribit provider router." + }, + "/deribit/reference": { + "description": "Deribit exchange reference data." + }, + "/deribit/market": { + "description": "Deribit market data." + }, + "/deribit/index": { + "description": "Deribit index data." + }, + "/deribit/rates": { + "description": "Deribit funding and yield data." + }, + "/deribit/volatility": { + "description": "Deribit volatility data." + }, + "/deribit/futures": { + "description": "Deribit futures data." + }, + "/deribit/options": { + "description": "Deribit options data and analysis." + }, + "/ecb": { + "description": "ECB provider router." + }, + "/econometrics": { + "description": "Econometrics panel-data regression commands." + }, + "/eia": { + "description": "EIA interactive data browsers." + }, + "/eia/coal": { + "description": "US coal production, consumption, quality, reserves, shipments, prices, and trade." + }, + "/eia/petroleum": { + "description": "US petroleum supply, disposition, prices, refining, movements, and stocks." + }, + "/eia/petroleum/consumption_sales": { + "description": "Consumption/Sales datasets." + }, + "/eia/petroleum/crude_reserves_and_production": { + "description": "Crude Reserves and Production datasets." + }, + "/eia/petroleum/imports_exports_and_movements": { + "description": "Imports/Exports and Movements datasets." + }, + "/eia/petroleum/prices": { + "description": "Prices datasets." + }, + "/eia/petroleum/refining_and_processing": { + "description": "Refining and Processing datasets." + }, + "/eia/petroleum/stocks": { + "description": "Stocks datasets." + }, + "/eia/petroleum/summary": { + "description": "Summary datasets." + }, + "/eia/natural_gas": { + "description": "US natural gas production, consumption, storage, trade, reserves, and prices." + }, + "/eia/natural_gas/consumption_end_use": { + "description": "Consumption / End Use datasets." + }, + "/eia/natural_gas/exploration_and_reserves": { + "description": "Exploration and Reserves datasets." + }, + "/eia/natural_gas/imports_and_exports_pipelines": { + "description": "Imports and Exports/Pipelines datasets." + }, + "/eia/natural_gas/prices": { + "description": "Prices datasets." + }, + "/eia/natural_gas/production": { + "description": "Production datasets." + }, + "/eia/natural_gas/storage": { + "description": "Storage datasets." + }, + "/eia/natural_gas/summary": { + "description": "Summary datasets." + }, + "/eia/electricity": { + "description": "US electric power operations, generator inventory, plant fuel data, and retail sales." + }, + "/eia/electricity_grid": { + "description": "Hourly and daily electric grid monitor: demand, generation by fuel, and interchange." + }, + "/eia/state_electricity_profiles": { + "description": "Annual state electricity profiles: rankings, capability, emissions, and net metering." + }, + "/eia/densified_biomass": { + "description": "Densified biomass (wood pellet) capacity, production, feedstocks, sales, and inventories." + }, + "/eia/nuclear_outages": { + "description": "Daily US nuclear generator capacity and outages, nationally and by facility." + }, + "/famafrench": { + "description": "Fama-French research factors and portfolios." + }, + "/federal_reserve": { + "description": "Federal Reserve provider router." + }, + "/federal_reserve/ffiec": { + "description": "FFIEC bank-supervision reports." + }, + "/federal_reserve/atlanta": { + "description": "Federal Reserve Bank of Atlanta indicators." + }, + "/federal_reserve/boston": { + "description": "Federal Reserve Bank of Boston indicators." + }, + "/federal_reserve/chicago": { + "description": "Federal Reserve Bank of Chicago indicators." + }, + "/federal_reserve/cleveland": { + "description": "Federal Reserve Bank of Cleveland indicators." + }, + "/federal_reserve/dallas": { + "description": "Federal Reserve Bank of Dallas indicators." + }, + "/federal_reserve/kc": { + "description": "Federal Reserve Bank of Kansas City indicators." + }, + "/federal_reserve/minneapolis": { + "description": "Federal Reserve Bank of Minneapolis indicators." + }, + "/federal_reserve/ny": { + "description": "Federal Reserve Bank of New York indicators." + }, + "/federal_reserve/philadelphia": { + "description": "Federal Reserve Bank of Philadelphia indicators." + }, + "/federal_reserve/richmond": { + "description": "Federal Reserve Bank of Richmond indicators." + }, + "/federal_reserve/sf": { + "description": "Federal Reserve Bank of San Francisco indicators." + }, + "/federal_reserve/stl": { + "description": "Federal Reserve Bank of Saint Louis indicators." + }, + "/finra": { + "description": "FINRA provider router." + }, + "/finra/equity": { + "description": "FINRA equity data." + }, + "/finra/equity/darkpool": { + "description": "FINRA OTC and ATS volume." + }, + "/finra/equity/shorts": { + "description": "FINRA short interest." + }, + "/finra/fixedincome": { + "description": "FINRA TRACE bond data." + }, + "/fred": { + "description": "FRED provider router." + }, + "/fred/commodity": { + "description": "FRED provider router." + }, + "/fred/commodity/price": { + "description": "FRED provider router." + }, + "/fred/fixedincome": { + "description": "FRED fixed income data." + }, + "/fred/fixedincome/corporate": { + "description": "FRED fixed income data." + }, + "/fred/economy": { + "description": "FRED economic data." + }, + "/fred/fixedincome/government": { + "description": "FRED fixed income data." + }, + "/fred/fixedincome/rate": { + "description": "FRED fixed income data." + }, + "/fred/fixedincome/spreads": { + "description": "FRED fixed income data." + }, + "/fred/economy/survey": { + "description": "FRED economic data." + }, + "/imf": { + "description": "IMF provider router." + }, + "/imf/portwatch": { + "description": "IMF Port Watch endpoints." + }, + "/jodi": { + "description": "Monthly petroleum and natural gas supply, demand, and stock statistics, self-reported by over 100 countries, from the Joint Organisations Data Initiative (JODI) World Databases." + }, + "/jodi/oil": { + "description": "JODI-Oil World Database. Monthly data from January 2002 to the most recent month." + }, + "/jodi/gas": { + "description": "JODI-Gas World Database. Monthly data from January 2009 to the most recent month." + }, + "/nasdaq": { + "description": "Nasdaq provider router." + }, + "/nasdaq/equity": { + "description": "Nasdaq equity data." + }, + "/nasdaq/equity/calendar": { + "description": "Nasdaq equity data." + }, + "/nasdaq/equity/fundamental": { + "description": "Nasdaq equity data." + }, + "/nasdaq/equity/ownership": { + "description": "Nasdaq equity data." + }, + "/nasdaq/equity/estimates": { + "description": "Nasdaq equity data." + }, + "/nasdaq/etf": { + "description": "Nasdaq ETF data." + }, + "/nasdaq/index": { + "description": "Nasdaq index data." + }, + "/nasdaq/crypto": { + "description": "Nasdaq crypto data." + }, + "/nasdaq/options": { + "description": "Nasdaq options data." + }, + "/nasdaq/economy": { + "description": "Nasdaq economic data." + }, + "/nasdaq/markets": { + "description": "Nasdaq market-wide data." + }, + "/nasdaq/nordic": { + "description": "Nasdaq Nordic and Baltic market data." + }, + "/news": { + "description": "RSS news feeds." + }, + "/oecd": { + "description": "OECD provider router." + }, + "/quantitative": { + "description": "Return-attribution commands." + }, + "/quantitative/rolling": { + "description": "Quantitative rolling-statistics commands." + }, + "/quantitative/stats": { + "description": "Quantitative statistics commands." + }, + "/quantitative/performance": { + "description": "Quantitative performance-metric commands." + }, + "/sec": { + "description": "U.S. Securities and Exchange Commission (SEC) public data." + }, + "/technical": { + "description": "Indicator catalogue." + }, + "/technical/signals": { + "description": "Market-regime classification." + }, + "/tmx": { + "description": "TMX provider router." + }, + "/tmx/equity": { + "description": "TMX equity data." + }, + "/tmx/equity/screener_builder": { + "description": "TMX equity data." + }, + "/tmx/equity/asset_info": { + "description": "TMX equity data." + }, + "/tmx/equity/fundamental": { + "description": "TMX equity data." + }, + "/tmx/equity/calendar": { + "description": "TMX equity data." + }, + "/tmx/equity/ownership": { + "description": "TMX equity data." + }, + "/tmx/equity/estimates": { + "description": "TMX equity data." + }, + "/tmx/etf": { + "description": "TMX exchange-traded fund data." + }, + "/tmx/etf/fund_info": { + "description": "TMX exchange-traded fund data." + }, + "/tmx/index": { + "description": "TMX index data." + }, + "/tmx/derivatives": { + "description": "TMX derivatives data." + }, + "/tmx/derivatives/options": { + "description": "TMX options data and analysis." + }, + "/tmx/derivatives/futures": { + "description": "TMX futures data." + }, + "/tmx/currency": { + "description": "TMX currency data." + }, + "/tmx/fixedincome": { + "description": "TMX fixed income data." + }, + "/tmx/markets": { + "description": "TMX market-wide data." + }, + "/tmx/news": { + "description": "TMX news." + }, + "/uscongress": { + "description": "Data connector to Congress.gov API." + }, + "/usda": { + "description": "Data connector to the U.S. Department of Agriculture." + }, + "/ustreasury": { + "description": "Data connector to the U.S. Treasury FiscalData API." + }, + "/yfinance": { + "description": "Yahoo Finance data and analytics." + }, + "/yfinance/funds": { + "description": "Yahoo Finance mutual fund & ETF analytics." + }, + "/yfinance/estimates": { + "description": "Yahoo Finance analyst estimates." + }, + "/yfinance/ownership": { + "description": "Yahoo Finance ownership data." + }, + "/yfinance/sectors": { + "description": "Yahoo Finance sector comparisons." + }, + "/yfinance/industry": { + "description": "Yahoo Finance industry comparisons." + }, + "/yfinance/equity": { + "description": "Yahoo Finance equity market data." + }, + "/yfinance/equity/price": { + "description": "Equity price data." + }, + "/yfinance/equity/fundamental": { + "description": "Equity fundamentals." + }, + "/yfinance/equity/estimates": { + "description": "Analyst estimates." + }, + "/yfinance/equity/ownership": { + "description": "Equity ownership." + }, + "/yfinance/equity/calendar": { + "description": "Equity calendars." + }, + "/yfinance/etf": { + "description": "Yahoo Finance ETF data." + }, + "/yfinance/derivatives": { + "description": "Yahoo Finance derivatives data." + }, + "/yfinance/derivatives/options": { + "description": "Options analysis." + }, + "/yfinance/derivatives/futures": { + "description": "Futures data." + }, + "/yfinance/index": { + "description": "Yahoo Finance index data." + }, + "/yfinance/index/price": { + "description": "Index price data." + }, + "/yfinance/crypto": { + "description": "Yahoo Finance crypto data." + }, + "/yfinance/crypto/price": { + "description": "Crypto price data." + }, + "/yfinance/currency": { + "description": "Yahoo Finance currency data." + }, + "/yfinance/currency/price": { + "description": "Currency price data." + }, + "/yfinance/economy": { + "description": "Yahoo Finance economic data." + }, + "/yfinance/tv_widget": { + "description": "Yahoo Finance data and analytics." + }, + "/yfinance/asset_info": { + "description": "Yahoo Finance data and analytics." + }, + "/yfinance/screener_builder": { + "description": "Yahoo Finance data and analytics." + }, + "/yfinance/rrg": { + "description": "Yahoo Finance data and analytics." + } + } } \ No newline at end of file